Excel.ConditionalFormatCollection class

Referenz

Paket:: excel

Stellt eine Auflistung aller bedingten Formate dar, die den Bereich überlappen.

Extends: OfficeExtension.ClientObject

Hinweise

Eigenschaften

context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
items	Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(type)	Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.
add(typeString)	Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.
clearAll()	Löscht alle bedingten Formate, die im aktuellen angegebenen Bereich aktiv sind.
getCount()	Gibt die Anzahl der bedingten Formate in der Arbeitsmappe zurück.
getItem(id)	Gibt ein bedingtes Format für die angegebene ID zurück.
getItemAt(index)	Gibt ein bedingtes Format am angegebenen Index zurück.
getItemOrNullObject(id)	Gibt ein bedingtes Format zurück, das durch seine ID identifiziert wird. Wenn das bedingte Formatobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
load(options)	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)	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)	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.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche `Excel.ConditionalFormatCollection` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Excel.Interfaces.ConditionalFormatCollectionData`) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.ConditionalFormat[];

Eigenschaftswert

Excel.ConditionalFormat[]

Details zur Methode

add(type)

Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.

add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;

Parameter

type: Excel.ConditionalFormatType

Der Typ des bedingten Formats, das hinzugefügt wird. Weitere Informationen finden Sie unter Excel.ConditionalFormatType .

Gibt zurück

Excel.ConditionalFormat

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();
});

add(typeString)

Fügt der Auflistung ein neues bedingtes Format mit der ersten/obersten Priorität hinzu.

add(typeString: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat;

Parameter

typeString: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

Der Typ des bedingten Formats, das hinzugefügt wird. Weitere Informationen finden Sie unter Excel.ConditionalFormatType .

Gibt zurück

Excel.ConditionalFormat

Hinweise

[ API-Satz: ExcelApi 1.6 ]

clearAll()

Löscht alle bedingten Formate, die im aktuellen angegebenen Bereich aktiv sind.

clearAll(): void;

Gibt zurück

void

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();
    range.conditionalFormats.clearAll();

    await context.sync();

    $(".conditional-formats").hide();
});

getCount()

Gibt die Anzahl der bedingten Formate in der Arbeitsmappe zurück.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:C3";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet);
    conditionalFormat.iconSetOrNullObject.style = Excel.IconSet.fourTrafficLights;
    const cfCount = range.conditionalFormats.getCount(); 

    await context.sync()
    console.log("Count: " + cfCount.value);
});

getItem(id)

Gibt ein bedingtes Format für die angegebene ID zurück.

getItem(id: string): Excel.ConditionalFormat;

Parameter

id: string

Die ID des bedingten Formats.

Gibt zurück

Excel.ConditionalFormat

Bedingtes Formatobjekt.

Hinweise

[ API-Satz: ExcelApi 1.6 ]

Beispiele

await Excel.run(async (context) => {
    const sheetName = "Sheet1";
    const rangeAddress = "A1:C3";
    const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
    const conditionalFormats = range.conditionalFormats;
    const conditionalFormat = conditionalFormats.getItemAt(3);
    await context.sync()

    console.log("Conditional Format at Item 3 Loaded");
});

getItemAt(index)

Gibt ein bedingtes Format am angegebenen Index zurück.

getItemAt(index: number): Excel.ConditionalFormat;

Parameter

index: number

Index der abzurufenden bedingten Formate.

Gibt zurück

Excel.ConditionalFormat

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.");
    }
});

getItemOrNullObject(id)

Gibt ein bedingtes Format zurück, das durch seine ID identifiziert wird. Wenn das bedingte Formatobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(id: string): Excel.ConditionalFormat;

Parameter

id: string

Die ID des bedingten Formats.

Gibt zurück

Excel.ConditionalFormat

Hinweise

[ API-Satz: ExcelApi 1.14 ]

load(options)

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.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;

Parameter

options: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.ConditionalFormatCollection

load(propertyNames)

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.ConditionalFormatCollection;

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.ConditionalFormatCollection

load(propertyNamesAndPaths)

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?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;

Parameter

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.ConditionalFormatCollection

toJSON()

Ü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.ConditionalFormatCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.ConditionalFormatCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;

Gibt zurück

Excel.Interfaces.ConditionalFormatCollectionData

Freigeben über

Excel.ConditionalFormatCollection class

Hinweise

Eigenschaften

Methoden

Details zur Eigenschaft

context

Eigenschaftswert

items

Eigenschaftswert

Details zur Methode

add(type)

Parameter

Gibt zurück

Hinweise

Beispiele

add(typeString)

Parameter

Gibt zurück

Hinweise

clearAll()

Gibt zurück

Hinweise

Beispiele

getCount()

Gibt zurück

Hinweise

Beispiele

getItem(id)

Parameter

Gibt zurück

Hinweise

Beispiele

getItemAt(index)

Parameter

Gibt zurück

Hinweise

Beispiele

getItemOrNullObject(id)

Parameter

Gibt zurück

Hinweise

load(options)

Parameter

Gibt zurück

load(propertyNames)

Parameter

Gibt zurück

load(propertyNamesAndPaths)

Parameter

Gibt zurück

toJSON()

Gibt zurück

Zusätzliche Ressourcen