Excel.ConditionalFormatCollection class

リファレンス

パッケージ:: excel

範囲と重複するすべての条件付き書式のコレクションを表します。

Extends: OfficeExtension.ClientObject

注釈

プロパティ

context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
items	このコレクション内に読み込まれた子アイテムを取得します。

メソッド

add(type)	コレクションに新しい条件付き書式を最初または最優先事項で追加します。
add(typeString)	コレクションに新しい条件付き書式を最初または最優先事項で追加します。
clearAll()	現在指定している範囲でアクティブなすべての条件付き書式をクリアする。
getCount()	ブック内の条件付き書式の数を返します。
getItem(id)	指定された ID に対応する条件付き書式を返します。
getItemAt(index)	指定されたインデックスに条件付き書式を返します。
getItemOrNullObject(id)	ID で識別される条件付き形式を返します。条件付き書式オブジェクトが存在しない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
toJSON()	API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドを `JSON.stringify()`オーバーライドします。 (`JSON.stringify`さらに、渡されるオブジェクトのメソッドを呼び出 `toJSON` します)。元 `Excel.ConditionalFormatCollection` のオブジェクトは API オブジェクトですが、 `toJSON` メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として `Excel.Interfaces.ConditionalFormatCollectionData`型指定) を返します。

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Excel.RequestContext

items

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Excel.ConditionalFormat[];

プロパティ値

Excel.ConditionalFormat[]

メソッドの詳細

add(type)

コレクションに新しい条件付き書式を最初または最優先事項で追加します。

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

パラメーター

type: Excel.ConditionalFormatType

追加される条件付き書式の種類。詳細は「Excel.ConditionalFormatType」をご覧ください。

戻り値

Excel.ConditionalFormat

注釈

[ API セット: ExcelApi 1.6 ]

例

// 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)

コレクションに新しい条件付き書式を最初または最優先事項で追加します。

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

パラメーター

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

追加される条件付き書式の種類。詳細は「Excel.ConditionalFormatType」をご覧ください。

戻り値

Excel.ConditionalFormat

注釈

[ API セット: ExcelApi 1.6 ]

clearAll()

現在指定している範囲でアクティブなすべての条件付き書式をクリアする。

clearAll(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.6 ]

例

// 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()

ブック内の条件付き書式の数を返します。

getCount(): OfficeExtension.ClientResult<number>;

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: ExcelApi 1.6 ]

例

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)

指定された ID に対応する条件付き書式を返します。

getItem(id: string): Excel.ConditionalFormat;

パラメーター

id: string

条件付き書式の ID。

戻り値

Excel.ConditionalFormat

条件付き書式オブジェクト。

注釈

[ API セット: ExcelApi 1.6 ]

例

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)

指定されたインデックスに条件付き書式を返します。

getItemAt(index: number): Excel.ConditionalFormat;

パラメーター

index: number

取得する条件付き書式のインデックス。

戻り値

Excel.ConditionalFormat

注釈

[ API セット: ExcelApi 1.6 ]

例

// 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)

ID で識別される条件付き形式を返します。条件付き書式オブジェクトが存在しない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getItemOrNullObject(id: string): Excel.ConditionalFormat;

パラメーター

id: string

条件付き書式の ID。

戻り値

Excel.ConditionalFormat

注釈

[ API セット: ExcelApi 1.14 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;

パラメーター

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

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Excel.ConditionalFormatCollection

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Excel.ConditionalFormatCollection

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;

パラメーター

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Excel.ConditionalFormatCollection

toJSON()

API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡されるオブジェクトのメソッドを呼び出 toJSON します)。元 Excel.ConditionalFormatCollection のオブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト (として Excel.Interfaces.ConditionalFormatCollectionData型指定) を返します。

toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;

戻り値

Excel.Interfaces.ConditionalFormatCollectionData

Excel.ConditionalFormatCollection class

注釈

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

items

プロパティ値

メソッドの詳細

add(type)

パラメーター

戻り値

注釈

例

add(typeString)

パラメーター

戻り値

注釈

clearAll()

戻り値

注釈

例

getCount()

戻り値

注釈

例

getItem(id)

パラメーター

戻り値

注釈

例

getItemAt(index)

パラメーター

戻り値

注釈

例

getItemOrNullObject(id)

パラメーター

戻り値

注釈

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

toJSON()

戻り値

フィードバック

その他のリソース