ConditionalFormattingCollection

ConditionalFormattingCollection class

Encapsulates a collection of FormatCondition objects.

class ConditionalFormattingCollection;

Methods

MethodDescription
get(number)Gets the FormatConditions element at the specified index.
removeArea(number, number, number, number)Remove all conditional formatting in the range.
copy(ConditionalFormattingCollection)Copies conditional formatting.
add()Adds a FormatConditions to the collection.
getCount()Gets the number of elements contained in.

get(number)

Gets the FormatConditions element at the specified index.

get(index: number) : FormatConditionCollection;

Parameters:

ParameterTypeDescription
indexnumberThe zero based index of the element.

Returns

FormatConditionCollection

removeArea(number, number, number, number)

Remove all conditional formatting in the range.

removeArea(startRow: number, startColumn: number, totalRows: number, totalColumns: number) : void;

Parameters:

ParameterTypeDescription
startRownumberThe start row of the range.
startColumnnumberThe start column of the range.
totalRowsnumberThe number of rows of the range.
totalColumnsnumberThe number of columns of the range.

copy(ConditionalFormattingCollection)

Copies conditional formatting.

copy(cfs: ConditionalFormattingCollection) : void;

Parameters:

ParameterTypeDescription
cfsConditionalFormattingCollectionThe conditional formatting

add()

Adds a FormatConditions to the collection.

add() : number;

Returns

FormatConditions object index.

getCount()

Gets the number of elements contained in.

getCount() : number;