次の方法で共有


Excel.ConditionalFormat class

条件付き書式の範囲、書式、規則、およびその他のプロパティをカプセル化するオブジェクト。 条件付き書式オブジェクト モデルの詳細については、「 Excel 範囲に条件付き書式を適用する」を参照してください。

Extends

注釈

[ API セット: ExcelApi 1.6 ]

プロパティ

cellValue

現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。

cellValueOrNullObject

現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。

colorScale

現在の条件付き書式が ColorScale 型の場合は、カラー スケールの条件付き書式プロパティを返します。

colorScaleOrNullObject

現在の条件付き書式が ColorScale 型の場合は、カラー スケールの条件付き書式プロパティを返します。

context

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

custom

現在の条件付き書式がカスタム型の場合は、カスタム条件付き書式プロパティを返します。

customOrNullObject

現在の条件付き書式がカスタム型の場合は、カスタム条件付き書式プロパティを返します。

dataBar

現在の条件付き書式がデータ バーの場合は、データ バーのプロパティを返します。

dataBarOrNullObject

現在の条件付き書式がデータ バーの場合は、データ バーのプロパティを返します。

iconSet

現在の条件付き書式が IconSet 型の場合は、アイコン セットの条件付き書式プロパティを返します。

iconSetOrNullObject

現在の条件付き書式が IconSet 型の場合は、アイコン セットの条件付き書式プロパティを返します。

id

現在の ConditionalFormatCollectionの条件付き書式の優先順位。

preset

事前設定された条件の条件付き形式を返します。 詳細については、Excel.PresetCriteriaConditionalFormatを参照してください。

presetOrNullObject

事前設定された条件の条件付き形式を返します。 詳細については、Excel.PresetCriteriaConditionalFormatを参照してください。

priority

この条件付き書式が現在存在する条件付き書式コレクション内の優先順位 (またはインデックス)。 これを変更すると、他の条件付き形式の優先順位も変更され、連続した優先順位が可能になります。 バックから始める場合は、負の優先順位を使用します。 境界を超える優先順位は、最大 (負の場合は最小) の優先順位を取得して設定します。 また、優先度を変更する場合は、さらに変更を加える場合は、その新しい優先度の場所にあるオブジェクトの新しいコピーを再フェッチする必要があることに注意してください。

stopIfTrue

この条件付き書式の条件が満たされた場合、優先順位の低い書式はそのセルに影響を及ぼしません。 値は、データ バー、アイコン セット、カラー スケールに null されます。これは、 StopIfTrue の概念がないためです。

textComparison

現在の条件付き書式がテキスト型の場合は、特定のテキスト条件付き書式プロパティを返します。 たとえば、"Text" という単語に一致するセルの書式を設定します。

textComparisonOrNullObject

現在の条件付き書式がテキスト型の場合は、特定のテキスト条件付き書式プロパティを返します。 たとえば、"Text" という単語に一致するセルの書式を設定します。

topBottom

現在の条件付き書式が TopBottom 型の場合は、上下の条件付き書式プロパティを返します。 たとえば、上位 10% または下位 10 個の項目を書式設定します。

topBottomOrNullObject

現在の条件付き書式が TopBottom 型の場合は、上下の条件付き書式プロパティを返します。 たとえば、上位 10% または下位 10 個の項目を書式設定します。

type

条件付き書式の種類。 一度に設定できるのは 1 つだけです。

メソッド

changeRuleToCellValue(properties)

条件付き書式ルールの種類をセル値に変更します。

changeRuleToColorScale()

条件付き書式ルールの種類をカラー スケールに変更します。

changeRuleToContainsText(properties)

条件付き書式ルールの種類をテキスト比較に変更します。

changeRuleToCustom(formula)

条件付き書式ルールの種類をカスタムに変更します。

changeRuleToDataBar()

条件付き書式ルールの種類をデータ バーに変更します。

changeRuleToIconSet()

条件付き書式ルールの種類をアイコン セットに変更します。

changeRuleToPresetCriteria(properties)

条件付き書式ルールの種類を事前設定された条件に変更します。

changeRuleToTopBottom(properties)

条件付き書式ルールの種類を上または下に変更します。

delete()

この条件付き書式を削除します。

getRange()

条件付き書式が適用された範囲を返す。 条件付き書式が複数の範囲に適用されている場合は、エラーをスローします。

getRangeOrNullObject()

conditonal 形式が適用される範囲を返します。 条件付き書式が複数の範囲に適用されている場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getRanges()

1 つまたは複数の四角形の範囲を含む RangeAreasを返します。この範囲に対して、この四角形の形式が適用されます。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

setRanges(ranges)

conditonal 形式ルールが適用される範囲を設定します。

toJSON()

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

プロパティの詳細

cellValue

現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。

readonly cellValue: Excel.CellValueConditionalFormat;

プロパティ値

注釈

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

cellValueOrNullObject

現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

colorScale

現在の条件付き書式が ColorScale 型の場合は、カラー スケールの条件付き書式プロパティを返します。

readonly colorScale: Excel.ColorScaleConditionalFormat;

プロパティ値

注釈

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

colorScaleOrNullObject

現在の条件付き書式が ColorScale 型の場合は、カラー スケールの条件付き書式プロパティを返します。

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

context

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

context: RequestContext;

プロパティ値

custom

現在の条件付き書式がカスタム型の場合は、カスタム条件付き書式プロパティを返します。

readonly custom: Excel.CustomConditionalFormat;

プロパティ値

注釈

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

customOrNullObject

現在の条件付き書式がカスタム型の場合は、カスタム条件付き書式プロパティを返します。

readonly customOrNullObject: Excel.CustomConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

dataBar

現在の条件付き書式がデータ バーの場合は、データ バーのプロパティを返します。

readonly dataBar: Excel.DataBarConditionalFormat;

プロパティ値

注釈

[ 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("B8:E13");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.dataBar);
    conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;

    await context.sync();
});

dataBarOrNullObject

現在の条件付き書式がデータ バーの場合は、データ バーのプロパティを返します。

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

iconSet

現在の条件付き書式が IconSet 型の場合は、アイコン セットの条件付き書式プロパティを返します。

readonly iconSet: Excel.IconSetConditionalFormat;

プロパティ値

注釈

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

iconSetOrNullObject

現在の条件付き書式が IconSet 型の場合は、アイコン セットの条件付き書式プロパティを返します。

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

id

現在の ConditionalFormatCollectionの条件付き書式の優先順位。

readonly id: string;

プロパティ値

string

注釈

[ API セット: ExcelApi 1.6 ]

preset

事前設定された条件の条件付き形式を返します。 詳細については、Excel.PresetCriteriaConditionalFormatを参照してください。

readonly preset: Excel.PresetCriteriaConditionalFormat;

プロパティ値

注釈

[ 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.presetCriteria);
    conditionalFormat.preset.format.font.color = "white";
    conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage };

    await context.sync();
});

presetOrNullObject

事前設定された条件の条件付き形式を返します。 詳細については、Excel.PresetCriteriaConditionalFormatを参照してください。

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

priority

この条件付き書式が現在存在する条件付き書式コレクション内の優先順位 (またはインデックス)。 これを変更すると、他の条件付き形式の優先順位も変更され、連続した優先順位が可能になります。 バックから始める場合は、負の優先順位を使用します。 境界を超える優先順位は、最大 (負の場合は最小) の優先順位を取得して設定します。 また、優先度を変更する場合は、さらに変更を加える場合は、その新しい優先度の場所にあるオブジェクトの新しいコピーを再フェッチする必要があることに注意してください。

priority: number;

プロパティ値

number

注釈

[ API セット: ExcelApi 1.6 ]

stopIfTrue

この条件付き書式の条件が満たされた場合、優先順位の低い書式はそのセルに影響を及ぼしません。 値は、データ バー、アイコン セット、カラー スケールに null されます。これは、 StopIfTrue の概念がないためです。

stopIfTrue: boolean;

プロパティ値

boolean

注釈

[ API セット: ExcelApi 1.6 ]

textComparison

現在の条件付き書式がテキスト型の場合は、特定のテキスト条件付き書式プロパティを返します。 たとえば、"Text" という単語に一致するセルの書式を設定します。

readonly textComparison: Excel.TextConditionalFormat;

プロパティ値

注釈

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

textComparisonOrNullObject

現在の条件付き書式がテキスト型の場合は、特定のテキスト条件付き書式プロパティを返します。 たとえば、"Text" という単語に一致するセルの書式を設定します。

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

topBottom

現在の条件付き書式が TopBottom 型の場合は、上下の条件付き書式プロパティを返します。 たとえば、上位 10% または下位 10 個の項目を書式設定します。

readonly topBottom: Excel.TopBottomConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

topBottomOrNullObject

現在の条件付き書式が TopBottom 型の場合は、上下の条件付き書式プロパティを返します。 たとえば、上位 10% または下位 10 個の項目を書式設定します。

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

プロパティ値

注釈

[ API セット: ExcelApi 1.6 ]

type

条件付き書式の種類。 一度に設定できるのは 1 つだけです。

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

プロパティ値

Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

注釈

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

メソッドの詳細

changeRuleToCellValue(properties)

条件付き書式ルールの種類をセル値に変更します。

changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;

パラメーター

properties
Excel.ConditionalCellValueRule

セル値の条件付き書式ルールに設定するプロパティ。

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

changeRuleToColorScale()

条件付き書式ルールの種類をカラー スケールに変更します。

changeRuleToColorScale(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

changeRuleToContainsText(properties)

条件付き書式ルールの種類をテキスト比較に変更します。

changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;

パラメーター

properties
Excel.ConditionalTextComparisonRule

テキスト比較の条件付き書式ルールに設定するプロパティ。

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

changeRuleToCustom(formula)

条件付き書式ルールの種類をカスタムに変更します。

changeRuleToCustom(formula: string): void;

パラメーター

formula

string

カスタム条件付き書式ルールに設定する数式。

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

changeRuleToDataBar()

条件付き書式ルールの種類をデータ バーに変更します。

changeRuleToDataBar(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

changeRuleToIconSet()

条件付き書式ルールの種類をアイコン セットに変更します。

changeRuleToIconSet(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

changeRuleToPresetCriteria(properties)

条件付き書式ルールの種類を事前設定された条件に変更します。

changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;

パラメーター

properties
Excel.ConditionalPresetCriteriaRule

事前設定された条件条件付き書式ルールに設定するプロパティ。

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

changeRuleToTopBottom(properties)

条件付き書式ルールの種類を上または下に変更します。

changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;

パラメーター

properties
Excel.ConditionalTopBottomRule

上/下の条件付き書式ルールに設定するプロパティ。

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

delete()

この条件付き書式を削除します。

delete(): void;

戻り値

void

注釈

[ API セット: ExcelApi 1.6 ]

getRange()

条件付き書式が適用された範囲を返す。 条件付き書式が複数の範囲に適用されている場合は、エラーをスローします。

getRange(): Excel.Range;

戻り値

注釈

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

getRangeOrNullObject()

conditonal 形式が適用される範囲を返します。 条件付き書式が複数の範囲に適用されている場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getRangeOrNullObject(): Excel.Range;

戻り値

注釈

[ API セット: ExcelApi 1.6 ]

getRanges()

1 つまたは複数の四角形の範囲を含む RangeAreasを返します。この範囲に対して、この四角形の形式が適用されます。

getRanges(): Excel.RangeAreas;

戻り値

注釈

[ API セット: ExcelApi 1.9 ]

load(options)

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

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

パラメーター

options
Excel.Interfaces.ConditionalFormatLoadOptions

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

戻り値

load(propertyNames)

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

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

パラメーター

propertyNames

string | string[]

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

戻り値

load(propertyNamesAndPaths)

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

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

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

戻り値

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

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

パラメーター

properties
Excel.Interfaces.ConditionalFormatUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options
OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Excel.ConditionalFormat): void;

パラメーター

戻り値

void

setRanges(ranges)

conditonal 形式ルールが適用される範囲を設定します。

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

パラメーター

ranges

Excel.Range | Excel.RangeAreas | string

この規則を適用する 1 つ以上の範囲のコレクション。

戻り値

void

注釈

[ API セット: ExcelApi 1.17 ]

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalFormatData;

戻り値