Excel.ConditionalFormat class

条件付き書式の範囲、形式、ルール、およびその他のプロパティをカプセル化するオブジェクト。An object encapsulating a conditional format's range, format, rule, and other properties. 条件付き書式のオブジェクトモデルの詳細については、「 Excel 範囲に条件付き書式を適用する」を参照してください。To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

Extends

プロパティ

cellValue

現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。Returns the cell value conditional format properties if the current conditional format is a CellValue type. たとえば、5 ~ 10 の範囲のすべてのセルの書式を設定します。For example to format all cells between 5 and 10. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

cellValueOrNullObject

現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。Returns the cell value conditional format properties if the current conditional format is a CellValue type. たとえば、5 ~ 10 の範囲のすべてのセルの書式を設定します。For example to format all cells between 5 and 10. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

colorScale

現在の条件付き書式が ColorScale 型の場合は、ColorScale 条件付き書式プロパティを返します。Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

colorScaleOrNullObject

現在の条件付き書式が ColorScale 型の場合は、ColorScale 条件付き書式プロパティを返します。Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

custom

現在の条件付き書式がカスタム型の場合は、カスタムの条件付き書式プロパティを返します。Returns the custom conditional format properties if the current conditional format is a custom type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

customOrNullObject

現在の条件付き書式がカスタム型の場合は、カスタムの条件付き書式プロパティを返します。Returns the custom conditional format properties if the current conditional format is a custom type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

dataBar

現在の条件付き書式がデータバーの場合、データバーのプロパティを返します。Returns the data bar properties if the current conditional format is a data bar. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

dataBarOrNullObject

現在の条件付き書式がデータバーの場合、データバーのプロパティを返します。Returns the data bar properties if the current conditional format is a data bar. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

iconSet

現在の条件付き書式が IconSet 型の場合は、IconSet 条件付き書式プロパティを返します。Returns the IconSet conditional format properties if the current conditional format is an IconSet type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

iconSetOrNullObject

現在の条件付き書式が IconSet 型の場合は、IconSet 条件付き書式プロパティを返します。Returns the IconSet conditional format properties if the current conditional format is an IconSet type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

id

現在の ConditionalFormatCollection 内での条件付き書式の優先順位。The Priority of the Conditional Format within the current ConditionalFormatCollection. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

preset

事前設定の条件の条件付き書式を返します。Returns the preset criteria conditional format. 詳細については、「PresetCriteriaConditionalFormat」を参照してください。See Excel.PresetCriteriaConditionalFormat for more details.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

presetOrNullObject

事前設定の条件の条件付き書式を返します。Returns the preset criteria conditional format. 詳細については、「PresetCriteriaConditionalFormat」を参照してください。See Excel.PresetCriteriaConditionalFormat for more details.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

priority

この条件付き書式が現在存在している条件付き書式コレクション内の優先度 (またはインデックス)。The priority (or index) within the conditional format collection that this conditional format currently exists in. これを変更すると、他の条件付き書式の優先度も変更され、連続した優先順位を使用できるようになります。Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. 最背面から開始するには、負の優先順位を使用します。Use a negative priority to begin from the back. 範囲よりも大きい優先度が取得され、最大値 (負の場合は負の値) に設定されます。Priorities greater than than bounds will get and set to the maximum (or minimum if negative) priority. また、優先度を変更する場合は、変更を加える必要がある場合は、新しい優先度の場所でオブジェクトの新しいコピーを取得し直す必要があることにも注意してください。Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

stopIfTrue

この条件付き書式の条件が満たされた場合、優先順位の低い書式はそのセルに影響を及ぼしません。If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. このような stop Iftrue の概念が存在しないため、(a) を使用する場合は、(a)Null on databars, icon sets, and colorscales as there's no concept of StopIfTrue for these

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

textComparison

現在の条件付き書式がテキスト型の場合、特定のテキスト条件付き書式プロパティを返します。Returns the specific text conditional format properties if the current conditional format is a text type. たとえば、"Text" という単語に一致するセルの書式を設定します。For example to format cells matching the word "Text". 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

textComparisonOrNullObject

現在の条件付き書式がテキスト型の場合、特定のテキスト条件付き書式プロパティを返します。Returns the specific text conditional format properties if the current conditional format is a text type. たとえば、"Text" という単語に一致するセルの書式を設定します。For example to format cells matching the word "Text". 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

topBottom

現在の条件付き書式が TopBottom 型の場合、上位/下位条件付き書式プロパティを返します。Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. たとえば、上位 10% または下位10個のアイテムを書式設定します。For example to format the top 10% or bottom 10 items. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

topBottomOrNullObject

現在の条件付き書式が TopBottom 型の場合、上位/下位条件付き書式プロパティを返します。Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. たとえば、上位 10% または下位10個のアイテムを書式設定します。For example to format the top 10% or bottom 10 items. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

type

条件付き書式の種類を指定します。A type of conditional format. 一度に設定できるのは1つだけです。Only one can be set at a time. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

メソッド

delete()

この条件付き書式を削除します。Deletes this conditional format.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

getRange()

条件付き書式が適用された範囲を返す。Returns the range the conditonal format is applied to. 複数の範囲に条件付き書式を適用すると、エラーがスローされます。Throws an error if the conditional format is applied to multiple ranges. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

getRangeOrNullObject()

Conditonal 書式が適用される範囲を返します。または、複数の範囲に条件付き書式が適用されている場合は、null オブジェクトを返します。Returns the range the conditonal format is applied to, or a null object if the conditional format is applied to multiple ranges. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

getRanges()

1 つまたは複数の長方形範囲で構成され、条件付き書式が適用された RangeAreas を返します。Returns the RangeAreas, comprising one or more rectangular ranges, the conditonal format is applied to. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の ConditionalFormat オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ConditionalFormatData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalFormatData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

cellValue

現在の条件付き書式が CellValue 型の場合は、セル値の条件付き書式プロパティを返します。Returns the cell value conditional format properties if the current conditional format is a CellValue type. たとえば、5 ~ 10 の範囲のすべてのセルの書式を設定します。For example to format all cells between 5 and 10. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly cellValue: Excel.CellValueConditionalFormat;

プロパティ値

Examples

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 型の場合は、セル値の条件付き書式プロパティを返します。Returns the cell value conditional format properties if the current conditional format is a CellValue type. たとえば、5 ~ 10 の範囲のすべてのセルの書式を設定します。For example to format all cells between 5 and 10. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

プロパティ値

colorScale

現在の条件付き書式が ColorScale 型の場合は、ColorScale 条件付き書式プロパティを返します。Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly colorScale: Excel.ColorScaleConditionalFormat;

プロパティ値

Examples

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 型の場合は、ColorScale 条件付き書式プロパティを返します。Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

プロパティ値

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

custom

現在の条件付き書式がカスタム型の場合は、カスタムの条件付き書式プロパティを返します。Returns the custom conditional format properties if the current conditional format is a custom type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly custom: Excel.CustomConditionalFormat;

プロパティ値

Examples

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

現在の条件付き書式がカスタム型の場合は、カスタムの条件付き書式プロパティを返します。Returns the custom conditional format properties if the current conditional format is a custom type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly customOrNullObject: Excel.CustomConditionalFormat;

プロパティ値

dataBar

現在の条件付き書式がデータバーの場合、データバーのプロパティを返します。Returns the data bar properties if the current conditional format is a data bar. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly dataBar: Excel.DataBarConditionalFormat;

プロパティ値

Examples

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

現在の条件付き書式がデータバーの場合、データバーのプロパティを返します。Returns the data bar properties if the current conditional format is a data bar. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

プロパティ値

iconSet

現在の条件付き書式が IconSet 型の場合は、IconSet 条件付き書式プロパティを返します。Returns the IconSet conditional format properties if the current conditional format is an IconSet type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly iconSet: Excel.IconSetConditionalFormat;

プロパティ値

Examples

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 this method does below, 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 型の場合は、IconSet 条件付き書式プロパティを返します。Returns the IconSet conditional format properties if the current conditional format is an IconSet type. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

プロパティ値

id

現在の ConditionalFormatCollection 内での条件付き書式の優先順位。The Priority of the Conditional Format within the current ConditionalFormatCollection. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly id: string;

プロパティ値

string

preset

事前設定の条件の条件付き書式を返します。Returns the preset criteria conditional format. 詳細については、「PresetCriteriaConditionalFormat」を参照してください。See Excel.PresetCriteriaConditionalFormat for more details.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly preset: Excel.PresetCriteriaConditionalFormat;

プロパティ値

Examples

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

事前設定の条件の条件付き書式を返します。Returns the preset criteria conditional format. 詳細については、「PresetCriteriaConditionalFormat」を参照してください。See Excel.PresetCriteriaConditionalFormat for more details.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

プロパティ値

priority

この条件付き書式が現在存在している条件付き書式コレクション内の優先度 (またはインデックス)。The priority (or index) within the conditional format collection that this conditional format currently exists in. これを変更すると、他の条件付き書式の優先度も変更され、連続した優先順位を使用できるようになります。Changing this also changes other conditional formats' priorities, to allow for a contiguous priority order. 最背面から開始するには、負の優先順位を使用します。Use a negative priority to begin from the back. 範囲よりも大きい優先度が取得され、最大値 (負の場合は負の値) に設定されます。Priorities greater than than bounds will get and set to the maximum (or minimum if negative) priority. また、優先度を変更する場合は、変更を加える必要がある場合は、新しい優先度の場所でオブジェクトの新しいコピーを取得し直す必要があることにも注意してください。Also note that if you change the priority, you have to re-fetch a new copy of the object at that new priority location if you want to make further changes to it. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

priority: number;

プロパティ値

number

stopIfTrue

この条件付き書式の条件が満たされた場合、優先順位の低い書式はそのセルに影響を及ぼしません。If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. このような stop Iftrue の概念が存在しないため、(a) を使用する場合は、(a)Null on databars, icon sets, and colorscales as there's no concept of StopIfTrue for these

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

stopIfTrue: boolean;

プロパティ値

boolean

textComparison

現在の条件付き書式がテキスト型の場合、特定のテキスト条件付き書式プロパティを返します。Returns the specific text conditional format properties if the current conditional format is a text type. たとえば、"Text" という単語に一致するセルの書式を設定します。For example to format cells matching the word "Text". 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly textComparison: Excel.TextConditionalFormat;

プロパティ値

Examples

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

現在の条件付き書式がテキスト型の場合、特定のテキスト条件付き書式プロパティを返します。Returns the specific text conditional format properties if the current conditional format is a text type. たとえば、"Text" という単語に一致するセルの書式を設定します。For example to format cells matching the word "Text". 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

プロパティ値

topBottom

現在の条件付き書式が TopBottom 型の場合、上位/下位条件付き書式プロパティを返します。Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. たとえば、上位 10% または下位10個のアイテムを書式設定します。For example to format the top 10% or bottom 10 items. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly topBottom: Excel.TopBottomConditionalFormat;

プロパティ値

topBottomOrNullObject

現在の条件付き書式が TopBottom 型の場合、上位/下位条件付き書式プロパティを返します。Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. たとえば、上位 10% または下位10個のアイテムを書式設定します。For example to format the top 10% or bottom 10 items. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

プロパティ値

type

条件付き書式の種類を指定します。A type of conditional format. 一度に設定できるのは1つだけです。Only one can be set at a time. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

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

プロパティ値

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

Examples

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

メソッドの詳細

delete()

この条件付き書式を削除します。Deletes this conditional format.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

delete(): void;

戻り値

void

getRange()

条件付き書式が適用された範囲を返す。Returns the range the conditonal format is applied to. 複数の範囲に条件付き書式を適用すると、エラーがスローされます。Throws an error if the conditional format is applied to multiple ranges. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

getRange(): Excel.Range;

戻り値

Examples

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 書式が適用される範囲を返します。または、複数の範囲に条件付き書式が適用されている場合は、null オブジェクトを返します。Returns the range the conditonal format is applied to, or a null object if the conditional format is applied to multiple ranges. 読み取り専用です。Read-only.

[API セット: excelapi 1.6][ API set: ExcelApi 1.6 ]

getRangeOrNullObject(): Excel.Range;

戻り値

getRanges()

1 つまたは複数の長方形範囲で構成され、条件付き書式が適用された RangeAreas を返します。Returns the RangeAreas, comprising one or more rectangular ranges, the conditonal format is applied to. 読み取り専用です。Read-only.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getRanges(): Excel.RangeAreas;

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.ConditionalFormat-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.ConditionalFormat - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormat-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.ConditionalFormat - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormat-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ConditionalFormat - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.ConditionalFormatUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.ConditionalFormat): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ConditionalFormat): void;

パラメーター

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の ConditionalFormat オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクト (として入力されます) を返します。Excel.Interfaces.ConditionalFormatData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalFormatData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ConditionalFormatData;

戻り値