PivotFormatCondition

PivotFormatCondition class

Represents a PivotTable Format Condition in PivotFormatCondition Collection.

class PivotFormatCondition;

Remarks

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

Properties

Property	Type	Description
scopeType	PivotConditionFormatScopeType	Get and set scope type for the pivot table conditional format .
ruleType	PivotConditionFormatRuleType	Get and set rule type for the pivot table condition format .
formatConditions	FormatConditionCollection	Readonly. Get conditions for the pivot table conditional format .

Methods

Method	Description
getScopeType()	@deprecated. Please use the ‘scopeType’ property instead. Get and set scope type for the pivot table conditional format .
setScopeType(PivotConditionFormatScopeType)	@deprecated. Please use the ‘scopeType’ property instead. Get and set scope type for the pivot table conditional format .
getRuleType()	@deprecated. Please use the ‘ruleType’ property instead. Get and set rule type for the pivot table condition format .
setRuleType(PivotConditionFormatRuleType)	@deprecated. Please use the ‘ruleType’ property instead. Get and set rule type for the pivot table condition format .
getFormatConditions()	@deprecated. Please use the ‘formatConditions’ property instead. 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.

scopeType

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

scopeType : PivotConditionFormatScopeType;

ruleType

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

ruleType : PivotConditionFormatRuleType;

formatConditions

Readonly. Get conditions for the pivot table conditional format .

formatConditions : FormatConditionCollection;

getScopeType()

@deprecated. Please use the ‘scopeType’ property instead. Get and set scope type for the pivot table conditional format .

getScopeType() : PivotConditionFormatScopeType;

Returns

PivotConditionFormatScopeType

setScopeType(PivotConditionFormatScopeType)

@deprecated. Please use the ‘scopeType’ property instead. Get and set scope type for the pivot table conditional format .

setScopeType(value: PivotConditionFormatScopeType) : void;

Parameters:

Parameter	Type	Description
value	PivotConditionFormatScopeType	The value to set.

getRuleType()

@deprecated. Please use the ‘ruleType’ property instead. Get and set rule type for the pivot table condition format .

getRuleType() : PivotConditionFormatRuleType;

Returns

PivotConditionFormatRuleType

setRuleType(PivotConditionFormatRuleType)

@deprecated. Please use the ‘ruleType’ property instead. Get and set rule type for the pivot table condition format .

setRuleType(value: PivotConditionFormatRuleType) : void;

Parameters:

Parameter	Type	Description
value	PivotConditionFormatRuleType	The value to set.

getFormatConditions()

@deprecated. Please use the ‘formatConditions’ property instead. 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:

Parameter	Type	Description
fieldName	string	The name of PivotField.

addDataAreaCondition(PivotField)

Adds PivotTable conditional format limit in the data fields.

addDataAreaCondition(dataField: PivotField) : void;

Parameters:

Parameter	Type	Description
dataField	PivotField	The PivotField in the data fields.

addRowAreaCondition(string)

Adds PivotTable conditional format limit in the row fields.

addRowAreaCondition(fieldName: string) : void;

Parameters:

Parameter	Type	Description
fieldName	string	The name of PivotField.

addRowAreaCondition(PivotField)

Adds PivotTable conditional format limit in the row fields.

addRowAreaCondition(rowField: PivotField) : void;

Parameters:

Parameter	Type	Description
rowField	PivotField	The PivotField in the row fields.

addColumnAreaCondition(string)

Adds PivotTable conditional format limit in the column fields.

addColumnAreaCondition(fieldName: string) : void;

Parameters:

Parameter	Type	Description
fieldName	string	The name of PivotField.

addColumnAreaCondition(PivotField)

Adds PivotTable conditional format limit in the column fields.

addColumnAreaCondition(columnField: PivotField) : void;

Parameters:

Parameter	Type	Description
columnField	PivotField	The PivotField in the column fields.

setConditionalAreas()

Sets conditional areas of PivotFormatCondition object.

setConditionalAreas() : void;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;