Interface IConditionalFormatCollection

Holds a collection of IConditionalFormats.

interface IConditionalFormatCollection {
    add(
        address: ICellRanges.Address,
        options: IConditionalFormatCollection.AddOptions,
    ): IConditionalFormat;
    getCount(): number;
    search(
        options?: IConditionalFormatCollection.SearchOptions,
    ): IConditionalFormat[];
}

Hierarchy (View Summary)

ICollection
- IConditionalFormatCollection

Index

Methods

add getCount search

Methods

add

add(
address: ICellRanges.Address,
options: IConditionalFormatCollection.AddOptions,
): IConditionalFormat
Add an IConditional to the container.
Parameters
- address: ICellRanges.Address
  The address of the item.
- options: IConditionalFormatCollection.AddOptions
  IConditionalFormatCollection.AddOptions
Returns IConditionalFormat

getCount

getCount(): number
Returns the total items available.

Returns number
Remarks
Useful as a quick escape for search.

Overrides ICollection.getCount

search

search(
options?: IConditionalFormatCollection.SearchOptions,
): IConditionalFormat[]
Returns items that match the search criteria.

If no search criteria is provided, all items will be returned.
Parameters
- Optionaloptions: IConditionalFormatCollection.SearchOptions
  IConditionalFormatCollection.SearchOptions
Returns IConditionalFormat[]