Excel.ConditionalFormatCollection class
Represents a collection of all the conditional formats that are overlap the range.
- Extends
Remarks
[Api set: ExcelApi 1.6]
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| items | Gets the loaded child items in this collection. |
Methods
| add(type) | Adds a new conditional format to the collection at the first/top priority. |
| add(type) | Adds a new conditional format to the collection at the first/top priority. |
| clear |
Clears all conditional formats active on the current specified range. |
| get |
Returns the number of conditional formats in the workbook. |
| get |
Returns a conditional format for the given ID. |
| get |
Returns a conditional format at the given index. |
| get |
Returns a conditional format identified by its ID. If the conditional format object does not exist, then this method returns an object with its |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
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
items
Gets the loaded child items in this collection.
readonly items: Excel.ConditionalFormat[];Property Value
Method Details
add(type)
Adds a new conditional format to the collection at the first/top priority.
add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;Parameters
The type of conditional format being added. See Excel.ConditionalFormatType for details.
Returns
Remarks
[Api set: ExcelApi 1.6]
add(type)
Adds a new conditional format to the collection at the first/top priority.
add(type: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat;Parameters
- type
-
"Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
The type of conditional format being added. See Excel.ConditionalFormatType for details.
Returns
Remarks
[Api set: ExcelApi 1.6]
clearAll()
Clears all conditional formats active on the current specified range.
clearAll(): void;Returns
void
Remarks
[Api set: ExcelApi 1.6]
getCount()
Returns the number of conditional formats in the workbook.
getCount(): OfficeExtension.ClientResult<number>;Returns
OfficeExtension.ClientResult<number>
Remarks
[Api set: ExcelApi 1.6]
getItem(id)
Returns a conditional format for the given ID.
getItem(id: string): Excel.ConditionalFormat;Parameters
- id
-
string
The ID of the conditional format.
Returns
Conditional format object.
Remarks
[Api set: ExcelApi 1.6]
getItemAt(index)
Returns a conditional format at the given index.
getItemAt(index: number): Excel.ConditionalFormat;Parameters
- index
-
number
Index of the conditional formats to be retrieved.
Returns
Remarks
[Api set: ExcelApi 1.6]
getItemOrNullObject(id)
Returns a conditional format identified by its ID. If the conditional format object does not exist, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.
getItemOrNullObject(id: string): Excel.ConditionalFormat;Parameters
- id
-
string
The ID of the conditional format.
Returns
Remarks
[Api set: ExcelApi 1.14]
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;Parameters
- options
-
Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Excel.ConditionalFormatCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
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's passed to it.) Whereas the original Excel.ConditionalFormatCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ConditionalFormatCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;