PivotFormatCondition

PivotFormatCondition class

Represents a PivotTable Format Condition in PivotFormatCondition Collection.

class PivotFormatCondition;

Remarks

NOTE: This class is now obsolete. Instead, please use PivotConditional class. This method will be removed 12 months later since December 2024. Aspose apologizes for any inconvenience you may have experienced.

Methods

MethodDescription
getScopeType()Get and set scope type for the pivot table conditional format .
setScopeType(PivotConditionFormatScopeType)Get and set scope type for the pivot table conditional format .
getRuleType()Get and set rule type for the pivot table condition format .
setRuleType(PivotConditionFormatRuleType)Get and set rule type for the pivot table condition format .
getFormatConditions()Get conditions for the pivot table conditional format .
addDataAreaCondition(string)Adds PivotTable conditional format limit in the data fields.
addDataAreaCondition(PivotField)Adds PivotTable conditional format limit in the data fields.
addRowAreaCondition(string)Adds PivotTable conditional format limit in the row fields.
addRowAreaCondition(PivotField)Adds PivotTable conditional format limit in the row fields.
addColumnAreaCondition(string)Adds PivotTable conditional format limit in the column fields.
addColumnAreaCondition(PivotField)Adds PivotTable conditional format limit in the column fields.
setConditionalAreas()Sets conditional areas of PivotFormatCondition object.
isNull()Checks whether the implementation object is null.

getScopeType()

Get and set scope type for the pivot table conditional format .

getScopeType() : PivotConditionFormatScopeType;

Returns

PivotConditionFormatScopeType

setScopeType(PivotConditionFormatScopeType)

Get and set scope type for the pivot table conditional format .

setScopeType(value: PivotConditionFormatScopeType) : void;

Parameters:

ParameterTypeDescription
valuePivotConditionFormatScopeTypeThe value to set.

getRuleType()

Get and set rule type for the pivot table condition format .

getRuleType() : PivotConditionFormatRuleType;

Returns

PivotConditionFormatRuleType

setRuleType(PivotConditionFormatRuleType)

Get and set rule type for the pivot table condition format .

setRuleType(value: PivotConditionFormatRuleType) : void;

Parameters:

ParameterTypeDescription
valuePivotConditionFormatRuleTypeThe value to set.

getFormatConditions()

Get conditions for the pivot table conditional format .

getFormatConditions() : FormatConditionCollection;

Returns

FormatConditionCollection

addDataAreaCondition(string)

Adds PivotTable conditional format limit in the data fields.

addDataAreaCondition(fieldName: string) : void;

Parameters:

ParameterTypeDescription
fieldNamestringThe name of PivotField.

addDataAreaCondition(PivotField)

Adds PivotTable conditional format limit in the data fields.

addDataAreaCondition(dataField: PivotField) : void;

Parameters:

ParameterTypeDescription
dataFieldPivotFieldThe PivotField in the data fields.

addRowAreaCondition(string)

Adds PivotTable conditional format limit in the row fields.

addRowAreaCondition(fieldName: string) : void;

Parameters:

ParameterTypeDescription
fieldNamestringThe name of PivotField.

addRowAreaCondition(PivotField)

Adds PivotTable conditional format limit in the row fields.

addRowAreaCondition(rowField: PivotField) : void;

Parameters:

ParameterTypeDescription
rowFieldPivotFieldThe PivotField in the row fields.

addColumnAreaCondition(string)

Adds PivotTable conditional format limit in the column fields.

addColumnAreaCondition(fieldName: string) : void;

Parameters:

ParameterTypeDescription
fieldNamestringThe name of PivotField.

addColumnAreaCondition(PivotField)

Adds PivotTable conditional format limit in the column fields.

addColumnAreaCondition(columnField: PivotField) : void;

Parameters:

ParameterTypeDescription
columnFieldPivotFieldThe PivotField in the column fields.

setConditionalAreas()

Sets conditional areas of PivotFormatCondition object.

setConditionalAreas() : void;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;