Excel.Interfaces.ConditionalFormatLoadOptions interface

Package:

excel

An object encapsulating a conditional format's range, format, rule, and other properties. To learn more about the conditional formatting object model, read Apply conditional formatting to Excel ranges.

Remarks

[ API set: ExcelApi 1.6 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
cellValue	Returns the cell value conditional format properties if the current conditional format is a CellValue type.
cellValueOrNullObject	Returns the cell value conditional format properties if the current conditional format is a CellValue type.
colorScale	Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
colorScaleOrNullObject	Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
custom	Returns the custom conditional format properties if the current conditional format is a custom type.
customOrNullObject	Returns the custom conditional format properties if the current conditional format is a custom type.
dataBar	Returns the data bar properties if the current conditional format is a data bar.
dataBarOrNullObject	Returns the data bar properties if the current conditional format is a data bar.
iconSet	Returns the icon set conditional format properties if the current conditional format is an IconSet type.
iconSetOrNullObject	Returns the icon set conditional format properties if the current conditional format is an IconSet type.
id	The priority of the conditional format in the current ConditionalFormatCollection.
preset	Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
presetOrNullObject	Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
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 the 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.
stopIfTrue	If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. Value is null on data bars, icon sets, and color scales as there's no concept of StopIfTrue for these.
textComparison	Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text".
textComparisonOrNullObject	Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text".
topBottom	Returns the top/bottom conditional format properties if the current conditional format is a TopBottom type. For example, to format the top 10% or bottom 10 items.
topBottomOrNullObject	Returns the top/bottom conditional format properties if the current conditional format is a TopBottom type. For example, to format the top 10% or bottom 10 items.
type	A type of conditional format. Only one can be set at a time.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

cellValue

Returns the cell value conditional format properties if the current conditional format is a CellValue type.

cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.CellValueConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

cellValueOrNullObject

Returns the cell value conditional format properties if the current conditional format is a CellValue type.

cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.CellValueConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

colorScale

Returns the color scale conditional format properties if the current conditional format is a ColorScale type.

colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.ColorScaleConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

colorScaleOrNullObject

Returns the color scale conditional format properties if the current conditional format is a ColorScale type.

colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.ColorScaleConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

custom

Returns the custom conditional format properties if the current conditional format is a custom type.

custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.CustomConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

customOrNullObject

Returns the custom conditional format properties if the current conditional format is a custom type.

customOrNullObject?: Excel.Interfaces.CustomConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.CustomConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

dataBar

Returns the data bar properties if the current conditional format is a data bar.

dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.DataBarConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

dataBarOrNullObject

Returns the data bar properties if the current conditional format is a data bar.

dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.DataBarConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

iconSet

Returns the icon set conditional format properties if the current conditional format is an IconSet type.

iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.IconSetConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

iconSetOrNullObject

Returns the icon set conditional format properties if the current conditional format is an IconSet type.

iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.IconSetConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

id

The priority of the conditional format in the current ConditionalFormatCollection.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

preset

Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

presetOrNullObject

Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions

Remarks

[ 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 the 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.

priority?: boolean;

Property Value

boolean

Remarks

[ 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. Value is null on data bars, icon sets, and color scales as there's no concept of StopIfTrue for these.

stopIfTrue?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]

textComparison

Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text".

textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.TextConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

textComparisonOrNullObject

Returns the specific text conditional format properties if the current conditional format is a text type. For example, to format cells matching the word "Text".

textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.TextConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

topBottom

Returns the top/bottom conditional format properties if the current conditional format is a TopBottom type. For example, to format the top 10% or bottom 10 items.

topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.TopBottomConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

topBottomOrNullObject

Returns the top/bottom conditional format properties if the current conditional format is a TopBottom type. For example, to format the top 10% or bottom 10 items.

topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;

Property Value

Excel.Interfaces.TopBottomConditionalFormatLoadOptions

Remarks

[ API set: ExcelApi 1.6 ]

type

A type of conditional format. Only one can be set at a time.

type?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.6 ]