Excel.ConditionalFormat class

Gibt die Eigenschaften des bedingten Formats des Zellwerts zurück, wenn das aktuelle bedingte Format ein CellValue Typ ist.

readonly cellValue: Excel.CellValueConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B21:E23");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.cellValue);
    conditionalFormat.cellValue.format.font.color = "red";
    conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" };

    await context.sync();
});

Gibt die Eigenschaften des bedingten Formats des Zellwerts zurück, wenn das aktuelle bedingte Format ein CellValue Typ ist.

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt die Eigenschaften des bedingten Formats der Farbskala zurück, wenn das aktuelle bedingte Format ein ColorScale Typ ist.

readonly colorScale: Excel.ColorScaleConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:M5");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.colorScale);
    const criteria = {
        minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
        midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
        maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
    };
    conditionalFormat.colorScale.criteria = criteria;

    await context.sync();
});

Gibt die Eigenschaften des bedingten Formats der Farbskala zurück, wenn das aktuelle bedingte Format ein ColorScale Typ ist.

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt die eigenschaften des benutzerdefinierten bedingten Formats zurück, wenn das aktuelle bedingte Format ein benutzerdefinierter Typ ist.

readonly custom: Excel.CustomConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom);
    conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)';
    conditionalFormat.custom.format.font.color = "green";

    await context.sync();
});

Gibt die eigenschaften des benutzerdefinierten bedingten Formats zurück, wenn das aktuelle bedingte Format ein benutzerdefinierter Typ ist.

readonly customOrNullObject: Excel.CustomConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt die Datenbalkeneigenschaften zurück, wenn das aktuelle bedingte Format ein Datenbalken ist.

readonly dataBar: Excel.DataBarConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.dataBar);
    conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;

    await context.sync();
});

Gibt die Datenbalkeneigenschaften zurück, wenn das aktuelle bedingte Format ein Datenbalken ist.

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt die Eigenschaften des bedingten Formats zurück, wenn das aktuelle bedingte Format ein IconSet Typ ist.

readonly iconSet: Excel.IconSetConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.iconSet);
    const iconSetCF = conditionalFormat.iconSet;
    iconSetCF.style = Excel.IconSet.threeTriangles;

    /*
        The iconSetCF.criteria array is automatically prepopulated with
        criterion elements whose properties have been given default settings.
        You can't write to each property of a criterion directly. Instead,
        replace the whole criteria object.

        With a "three*" icon set style, such as "threeTriangles", the third
        element in the criteria array (criteria[2]) defines the "top" icon;
        e.g., a green triangle. The second (criteria[1]) defines the "middle"
        icon. The first (criteria[0]) defines the "low" icon, but it
        can often be left empty as the following object shows, because every
        cell that does not match the other two criteria always gets the low
        icon.            
    */
    iconSetCF.criteria = [
        {} as any,
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=700"
        },
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=1000",
        }
    ];

    await context.sync();
});

Gibt die Eigenschaften des bedingten Formats zurück, wenn das aktuelle bedingte Format ein IconSet Typ ist.

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Die Priorität des bedingten Formats im aktuellen ConditionalFormatCollection.

readonly id: string;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt das bedingte Format der voreingestellten Kriterien zurück. Weitere Details finden Sie unter Excel.PresetCriteriaConditionalFormat.

readonly preset: Excel.PresetCriteriaConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:M5");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.presetCriteria);
    conditionalFormat.preset.format.font.color = "white";
    conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage };

    await context.sync();
});

Gibt das bedingte Format der voreingestellten Kriterien zurück. Weitere Details finden Sie unter Excel.PresetCriteriaConditionalFormat.

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Die Priorität (oder der Index) in der Auflistung des bedingten Formats, in der dieses bedingte Format derzeit vorhanden ist. Wenn Sie dies ändern, ändern sich auch die Prioritäten anderer bedingter Formate, um eine zusammenhängende Prioritätsreihenfolge zu ermöglichen. Verwenden Sie eine negative Priorität, um von hinten zu beginnen. Prioritäten, die größer als die Begrenzungen sind, werden auf die maximale (oder minimale, wenn negative) Priorität festgelegt. Beachten Sie außerdem, dass Sie beim Ändern der Priorität eine neue Kopie des Objekts an dieser neuen Prioritätsposition abrufen müssen, wenn Sie weitere Änderungen daran vornehmen möchten.

priority: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Wenn die Bedingungen dieses bedingten Formats erfüllt sind, werden keine Formate niedrigerer Priorität für diese Zelle wirksam. Der Wert ergibt sich null aus Datenbalken, Symbolsätzen und Farbskalen, da es für diese kein Konzept von StopIfTrue gibt.

stopIfTrue: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt die spezifischen Eigenschaften des bedingten Textformats zurück, wenn das aktuelle bedingte Format ein Texttyp ist. Beispielsweise, um Zellen zu formatieren, die dem Wort "Text" entsprechen.

readonly textComparison: Excel.TextConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B16:D18");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.containsText);
    conditionalFormat.textComparison.format.font.color = "red";
    conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" };

    await context.sync();
});

Gibt die spezifischen Eigenschaften des bedingten Textformats zurück, wenn das aktuelle bedingte Format ein Texttyp ist. Beispielsweise, um Zellen zu formatieren, die dem Wort "Text" entsprechen.

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt die Eigenschaften des oberen/unteren bedingten Formats zurück, wenn das aktuelle bedingte Format ein TopBottom Typ ist. Beispielsweise, um die obersten 10 % oder die unteren 10 Elemente zu formatieren.

readonly topBottom: Excel.TopBottomConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt die Eigenschaften des oberen/unteren bedingten Formats zurück, wenn das aktuelle bedingte Format ein TopBottom Typ ist. Beispielsweise, um die obersten 10 % oder die unteren 10 Elemente zu formatieren.

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Ein Typ des bedingten Formats. Es kann jeweils nur eine festgelegt werden.

readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const worksheetRange = sheet.getRange();
    worksheetRange.conditionalFormats.load("type");

    await context.sync();

    let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
    worksheetRange.conditionalFormats.items.forEach(item => {
        cfRangePairs.push({
            cf: item,
            range: item.getRange().load("address")
        });
    });

    await context.sync();

    if (cfRangePairs.length > 0) {
        cfRangePairs.forEach(item => {
            console.log(item.cf.type);
        });
    } else {
        console.log("No conditional formats applied.");
    }
});

Ändern Sie den Regeltyp des bedingten Formats in den Zellwert.

changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Ändern Sie den Regeltyp des bedingten Formats in farbskala.

changeRuleToColorScale(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Ändern Sie den Regeltyp des bedingten Formats in den Textvergleich.

changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Ändern Sie den Regeltyp des bedingten Formats in benutzerdefiniert.

changeRuleToCustom(formula: string): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Ändern Sie den Regeltyp des bedingten Formats in Datenleiste.

changeRuleToDataBar(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Ändern Sie den Regeltyp des bedingten Formats in den Symbolsatz.

changeRuleToIconSet(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Ändern Sie den Regeltyp des bedingten Formats in voreingestellte Kriterien.

changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Ändern Sie den Regeltyp des bedingten Formats in oben/unten.

changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Löscht dieses bedingte Format.

delete(): void;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt den Bereich zurück, auf den das bedingte Format angewendet wird. Löst einen Fehler aus, wenn das bedingte Format auf mehrere Bereiche angewendet wird.

getRange(): Excel.Range;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const worksheetRange = sheet.getRange();
    worksheetRange.conditionalFormats.load("type");

    await context.sync();

    let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
    worksheetRange.conditionalFormats.items.forEach(item => {
        cfRangePairs.push({
            cf: item,
            range: item.getRange().load("address")
        });
    });

    await context.sync();

    if (cfRangePairs.length > 0) {
        cfRangePairs.forEach(item => {
            console.log(item.cf.type);
        });
    } else {
        console.log("No conditional formats applied.");
    }
});

Gibt den Bereich zurück, auf den das konditonale Format angewendet wird. Wenn das bedingte Format auf mehrere Bereiche angewendet wird, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getRangeOrNullObject(): Excel.Range;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Gibt den zurück, der RangeAreaseinen oder mehrere rechteckige Bereiche umfasst, auf die das konditonale Format angewendet wird.

getRanges(): Excel.RangeAreas;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.ConditionalFormat;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalFormat;

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.ConditionalFormat): void;

Parameter

Gibt zurück

Legen Sie die Bereiche fest, auf die die Konditonalformatregel angewendet wird.

setRanges(ranges: Range | RangeAreas | string): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.ConditionalFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ConditionalFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.ConditionalFormatData;

Gibt zurück