Excel.PresetCriteriaConditionalFormat class

Represents the the preset criteria conditional format such as above average, below average, unique values, contains blank, nonblank, error, and noerror.

[ API set: ExcelApi 1.6 ]

Extends

Properties

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

format

Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.

[ API set: ExcelApi 1.6 ]

rule

The rule of the conditional format.

[ API set: ExcelApi 1.6 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PresetCriteriaConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PresetCriteriaConditionalFormatData) that contains shallow copies of any loaded child properties from the original object.

Property Details

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

RequestContext

format

Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.

[ API set: ExcelApi 1.6 ]

readonly format: Excel.ConditionalRangeFormat;

Property Value

rule

The rule of the conditional format.

[ API set: ExcelApi 1.6 ]

rule: Excel.ConditionalPresetCriteriaRule;

Property Value

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

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.PresetCriteriaConditionalFormat;

Parameters

option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.PresetCriteriaConditionalFormat - 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.PresetCriteriaConditionalFormat - Only available on collection types. It is similar to the preceding signature. 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. If option.top is specified, the result set will start after skipping the specified number of items.

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.PresetCriteriaConditionalFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.PresetCriteriaConditionalFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.PresetCriteriaConditionalFormatData;

Returns