Excel.Interfaces.ConditionalFormatCollectionLoadOptions interface

Represents a collection of all the conditional formats that are overlap the range.

[ API set: ExcelApi 1.6 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

cellValue

For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a CellValue type. For example to format all cells between 5 and 10.

[ API set: ExcelApi 1.6 ]

cellValueOrNullObject

For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a CellValue type. For example to format all cells between 5 and 10.

[ API set: ExcelApi 1.6 ]

colorScale

For EACH ITEM in the collection: Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.

[ API set: ExcelApi 1.6 ]

colorScaleOrNullObject

For EACH ITEM in the collection: Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.

[ API set: ExcelApi 1.6 ]

custom

For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type.

[ API set: ExcelApi 1.6 ]

customOrNullObject

For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type.

[ API set: ExcelApi 1.6 ]

dataBar

For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar.

[ API set: ExcelApi 1.6 ]

dataBarOrNullObject

For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar.

[ API set: ExcelApi 1.6 ]

iconSet

For EACH ITEM in the collection: Returns the IconSet conditional format properties if the current conditional format is an IconSet type.

[ API set: ExcelApi 1.6 ]

iconSetOrNullObject

For EACH ITEM in the collection: Returns the IconSet conditional format properties if the current conditional format is an IconSet type.

[ API set: ExcelApi 1.6 ]

id

For EACH ITEM in the collection: The Priority of the Conditional Format within the current ConditionalFormatCollection.

[ API set: ExcelApi 1.6 ]

preset

For EACH ITEM in the collection: Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

[ API set: ExcelApi 1.6 ]

presetOrNullObject

For EACH ITEM in the collection: Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

[ API set: ExcelApi 1.6 ]

priority

For EACH ITEM in the collection: 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.

[ API set: ExcelApi 1.6 ]

stopIfTrue

For EACH ITEM in the collection: If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. Null on databars, icon sets, and colorscales as there's no concept of StopIfTrue for these

[ API set: ExcelApi 1.6 ]

textComparison

For EACH ITEM in the collection: 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".

[ API set: ExcelApi 1.6 ]

textComparisonOrNullObject

For EACH ITEM in the collection: 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".

[ API set: ExcelApi 1.6 ]

topBottom

For EACH ITEM in the collection: Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. For example to format the top 10% or bottom 10 items.

[ API set: ExcelApi 1.6 ]

topBottomOrNullObject

For EACH ITEM in the collection: Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. For example to format the top 10% or bottom 10 items.

[ API set: ExcelApi 1.6 ]

type

For EACH ITEM in the collection: A type of conditional format. Only one can be set at a time.

[ API set: ExcelApi 1.6 ]

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

cellValue

For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a CellValue type. For example to format all cells between 5 and 10.

[ API set: ExcelApi 1.6 ]

cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;

Property Value

cellValueOrNullObject

For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a CellValue type. For example to format all cells between 5 and 10.

[ API set: ExcelApi 1.6 ]

cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;

Property Value

colorScale

For EACH ITEM in the collection: Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.

[ API set: ExcelApi 1.6 ]

colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;

Property Value

colorScaleOrNullObject

For EACH ITEM in the collection: Returns the ColorScale conditional format properties if the current conditional format is an ColorScale type.

[ API set: ExcelApi 1.6 ]

colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;

Property Value

custom

For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type.

[ API set: ExcelApi 1.6 ]

custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions;

Property Value

customOrNullObject

For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type.

[ API set: ExcelApi 1.6 ]

customOrNullObject?: Excel.Interfaces.CustomConditionalFormatLoadOptions;

Property Value

dataBar

For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar.

[ API set: ExcelApi 1.6 ]

dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;

Property Value

dataBarOrNullObject

For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar.

[ API set: ExcelApi 1.6 ]

dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;

Property Value

iconSet

For EACH ITEM in the collection: Returns the IconSet conditional format properties if the current conditional format is an IconSet type.

[ API set: ExcelApi 1.6 ]

iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;

Property Value

iconSetOrNullObject

For EACH ITEM in the collection: Returns the IconSet conditional format properties if the current conditional format is an IconSet type.

[ API set: ExcelApi 1.6 ]

iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;

Property Value

id

For EACH ITEM in the collection: The Priority of the Conditional Format within the current ConditionalFormatCollection.

[ API set: ExcelApi 1.6 ]

id?: boolean;

Property Value

boolean

preset

For EACH ITEM in the collection: Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

[ API set: ExcelApi 1.6 ]

preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;

Property Value

presetOrNullObject

For EACH ITEM in the collection: Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.

[ API set: ExcelApi 1.6 ]

presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;

Property Value

priority

For EACH ITEM in the collection: 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.

[ API set: ExcelApi 1.6 ]

priority?: boolean;

Property Value

boolean

stopIfTrue

For EACH ITEM in the collection: If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. Null on databars, icon sets, and colorscales as there's no concept of StopIfTrue for these

[ API set: ExcelApi 1.6 ]

stopIfTrue?: boolean;

Property Value

boolean

textComparison

For EACH ITEM in the collection: 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".

[ API set: ExcelApi 1.6 ]

textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions;

Property Value

textComparisonOrNullObject

For EACH ITEM in the collection: 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".

[ API set: ExcelApi 1.6 ]

textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatLoadOptions;

Property Value

topBottom

For EACH ITEM in the collection: Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. For example to format the top 10% or bottom 10 items.

[ API set: ExcelApi 1.6 ]

topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;

Property Value

topBottomOrNullObject

For EACH ITEM in the collection: Returns the Top/Bottom conditional format properties if the current conditional format is an TopBottom type. For example to format the top 10% or bottom 10 items.

[ API set: ExcelApi 1.6 ]

topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;

Property Value

type

For EACH ITEM in the collection: A type of conditional format. Only one can be set at a time.

[ API set: ExcelApi 1.6 ]

type?: boolean;

Property Value

boolean