Excel.Interfaces.ConditionalFormatUpdateData interface
An interface for updating data on the ConditionalFormat object, for use in conditionalFormat.set({ ... }).
Properties
| cell |
Returns the cell value conditional format properties if the current conditional format is a |
| cell |
Returns the cell value conditional format properties if the current conditional format is a |
| color |
Returns the color scale conditional format properties if the current conditional format is a |
| color |
Returns the color scale conditional format properties if the current conditional format is a |
| custom | Returns the custom conditional format properties if the current conditional format is a custom type. |
| custom |
Returns the custom conditional format properties if the current conditional format is a custom type. |
| data |
Returns the data bar properties if the current conditional format is a data bar. |
| data |
Returns the data bar properties if the current conditional format is a data bar. |
| icon |
Returns the icon set conditional format properties if the current conditional format is an |
| icon |
Returns the icon set conditional format properties if the current conditional format is an |
| preset | Returns the preset criteria conditional format. See |
| preset |
Returns the preset criteria conditional format. See |
| 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. |
| stop |
If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell. Value is |
| text |
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 |
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 |
Returns the top/bottom conditional format properties if the current conditional format is a |
| top |
Returns the top/bottom conditional format properties if the current conditional format is a |
Property Details
cellValue
Returns the cell value conditional format properties if the current conditional format is a CellValue type.
cellValue?: Excel.Interfaces.CellValueConditionalFormatUpdateData;Property Value
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.CellValueConditionalFormatUpdateData;Property Value
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.ColorScaleConditionalFormatUpdateData;Property Value
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.ColorScaleConditionalFormatUpdateData;Property Value
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.CustomConditionalFormatUpdateData;Property Value
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.CustomConditionalFormatUpdateData;Property Value
Remarks
[Api set: ExcelApi 1.6]
dataBar
Returns the data bar properties if the current conditional format is a data bar.
dataBar?: Excel.Interfaces.DataBarConditionalFormatUpdateData;Property Value
Remarks
[Api set: ExcelApi 1.6]
dataBarOrNullObject
Returns the data bar properties if the current conditional format is a data bar.
dataBarOrNullObject?: Excel.Interfaces.DataBarConditionalFormatUpdateData;Property Value
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.IconSetConditionalFormatUpdateData;Property Value
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.IconSetConditionalFormatUpdateData;Property Value
Remarks
[Api set: ExcelApi 1.6]
preset
Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
preset?: Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData;Property Value
Remarks
[Api set: ExcelApi 1.6]
presetOrNullObject
Returns the preset criteria conditional format. See Excel.PresetCriteriaConditionalFormat for more details.
presetOrNullObject?: Excel.Interfaces.PresetCriteriaConditionalFormatUpdateData;Property Value
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?: number;Property Value
number
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.TextConditionalFormatUpdateData;Property Value
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.TextConditionalFormatUpdateData;Property Value
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.TopBottomConditionalFormatUpdateData;Property Value
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.TopBottomConditionalFormatUpdateData;Property Value
Remarks
[Api set: ExcelApi 1.6]