Excel.Interfaces.ConditionalFormatCollectionLoadOptions interface
Represents a collection of all the conditional formats that are overlap the range.
Remarks
[Api set: ExcelApi 1.6]
Properties
| $all | Specifying |
| cell |
For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a |
| cell |
For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a |
| color |
For EACH ITEM in the collection: Returns the color scale conditional format properties if the current conditional format is a |
| color |
For EACH ITEM in the collection: Returns the color scale conditional format properties if the current conditional format is a |
| custom | For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type. |
| custom |
For EACH ITEM in the collection: Returns the custom conditional format properties if the current conditional format is a custom type. |
| data |
For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar. |
| data |
For EACH ITEM in the collection: Returns the data bar properties if the current conditional format is a data bar. |
| icon |
For EACH ITEM in the collection: Returns the icon set conditional format properties if the current conditional format is an |
| icon |
For EACH ITEM in the collection: Returns the icon set conditional format properties if the current conditional format is an |
| id | For EACH ITEM in the collection: The priority of the conditional format in the current |
| preset | For EACH ITEM in the collection: Returns the preset criteria conditional format. See |
| preset |
For EACH ITEM in the collection: Returns the preset criteria conditional format. See |
| 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 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. |
| stop |
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. Value is |
| text |
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". |
| text |
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". |
| top |
For EACH ITEM in the collection: Returns the top/bottom conditional format properties if the current conditional format is a |
| top |
For EACH ITEM in the collection: Returns the top/bottom conditional format properties if the current conditional format is a |
| type | For EACH ITEM in the collection: 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
For EACH ITEM in the collection: Returns the cell value conditional format properties if the current conditional format is a CellValue type.
cellValue?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;Property Value
Remarks
[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.
cellValueOrNullObject?: Excel.Interfaces.CellValueConditionalFormatLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.6]
colorScale
For EACH ITEM in the collection: Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
colorScale?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.6]
colorScaleOrNullObject
For EACH ITEM in the collection: Returns the color scale conditional format properties if the current conditional format is a ColorScale type.
colorScaleOrNullObject?: Excel.Interfaces.ColorScaleConditionalFormatLoadOptions;Property Value
Remarks
[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.
custom?: Excel.Interfaces.CustomConditionalFormatLoadOptions;Property Value
Remarks
[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.
customOrNullObject?: Excel.Interfaces.CustomConditionalFormatLoadOptions;Property Value
Remarks
[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.
dataBar?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;Property Value
Remarks
[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.
dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.6]
iconSet
For EACH ITEM in the collection: Returns the icon set conditional format properties if the current conditional format is an IconSet type.
iconSet?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.6]
iconSetOrNullObject
For EACH ITEM in the collection: Returns the icon set conditional format properties if the current conditional format is an IconSet type.
iconSetOrNullObject?: Excel.Interfaces.IconSetConditionalFormatLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.6]
id
For EACH ITEM in the collection: The priority of the conditional format in the current ConditionalFormatCollection.
id?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.6]
preset
For EACH ITEM in the collection: Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
preset?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;Property Value
Remarks
[Api set: ExcelApi 1.6]
presetOrNullObject
For EACH ITEM in the collection: Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatLoadOptions;Property Value
Remarks
[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 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
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. 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
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".
textComparison?: Excel.Interfaces.TextConditionalFormatLoadOptions;Property Value
Remarks
[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".
textComparisonOrNullObject?: Excel.Interfaces.TextConditionalFormatLoadOptions;Property Value
Remarks
[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 a TopBottom type. For example, to format the top 10% or bottom 10 items.
topBottom?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;Property Value
Remarks
[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 a TopBottom type. For example, to format the top 10% or bottom 10 items.
topBottomOrNullObject?: Excel.Interfaces.TopBottomConditionalFormatLoadOptions;Property Value
Remarks
[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.
type?: boolean;Property Value
boolean
Remarks
[Api set: ExcelApi 1.6]