ApiIconSetCondition

Class representing an icon set conditional formatting rule.

ApiIconSetCondition is a subclass of ApiFormatCondition.

Properties

Name	Type	Description
Formula	string	Returns the formula associated with the icon set condition.
IconCriteria	ApiIconCriterion[]	Returns a collection of icon criteria that represent the threshold values and icons for the icon set conditional formatting rule.
IconSet	XlIconSet	Returns or sets the icon set type used in the conditional formatting rule.
PercentileValues	boolean	Returns or sets whether the thresholds for the icon set conditional format are determined by using percentiles.
ReverseOrder	boolean	Returns or sets whether the icon order in the icon set rule is reversed.
ShowIconOnly	boolean	Returns or sets whether to display only icons in the icon set rule (without cell values).
Type	XlFormatConditionType	Returns the type of the icon set conditional formatting rule.

Methods

The following table lists the available methods.

Method	Returns	Description
Delete	None	Deletes the icon set conditional formatting rule.
GetAppliesTo	ApiRange	Returns the range of cells to which the current conditional formatting rule applies.
GetDateOperator	XlTimePeriods | null	Returns the date operator for time period conditions.
GetFillColor	ApiColor | 'No Fill'	Returns the background color for the format condition.
GetFont	ApiFont | null	Returns the font applied by the current format condition.
GetFormula	string	Returns the formula associated with the icon set condition.
GetFormula1	string	Returns the first formula used by the current conditional formatting rule.
GetFormula2	string	Returns the second formula used by the current conditional formatting rule.
GetIconCriteria	ApiIconCriterion[] | null	Returns a collection of icon criteria that represent the threshold values and icons for the icon set conditional formatting rule.
GetIconSet	XlIconSet | null	Returns the icon set type used in the conditional formatting rule.
GetNumberFormat	string	Returns the number format applied to a cell when the conditional formatting rule evaluates to true.
GetOperator	XlFormatConditionOperator	Returns the format condition operator.
GetPTCondition	PTCondition | null	Returns the pivot table condition object.
GetParent	ApiRange	Returns the parent range object of the current format condition.
GetPercentileValues	boolean	Returns whether the thresholds for the icon set conditional format are determined by using percentiles.
GetPriority	number	Returns the priority value of the conditional formatting rule.
GetReverseOrder	boolean | null	Returns whether the icon order in the icon set rule is reversed.
GetScopeType	XlPivotConditionScope	Returns the scope type of the conditional formatting rule.
GetShowIconOnly	boolean | null	Returns whether only icons are displayed in the icon set rule (without cell values).
GetStopIfTrue	boolean	Returns whether the editor will stop evaluating additional formatting rules if this rule evaluates to true. This rule type cannot stop the evaluation, so the value can be changed only by opening a file where it is set.
GetText	string	Returns the text value used in text-based conditional formatting rules.
GetTextOperator	XlContainsOperator | null	Returns the text operator for text-based conditional formatting rules.
GetType	XlFormatConditionType	Returns the type of the icon set conditional formatting rule.
Modify	ApiFormatCondition | null	Modifies the current format condition with the specified parameters.
ModifyAppliesToRange	None	Modifies the cell range to which the current conditional formatting rule applies.
SetBorders	None	Sets the border style for the conditional formatting rule.
SetDateOperator	None	Sets the date operator for time period conditions.
SetFillColor	None	Sets the background color to the format condition with the previously created color object.
SetFirstPriority	None	Sets the priority value for the current conditional formatting rule to "1" so that it will be evaluated before all other rules on the worksheet.
SetIconSet	boolean	Sets the icon set type for the conditional formatting rule.
SetLastPriority	None	Sets the evaluation order for the current conditional formatting rule so it is evaluated after all other rules on the worksheet.
SetNumberFormat	None	Sets the number format applied to a cell when the conditional formatting rule evaluates to true.
SetPercentileValues	boolean	Specifies whether the thresholds for the icon set conditional format are determined by using percentiles.
SetPriority	None	Sets the priority value for the conditional formatting rule.
SetReverseOrder	boolean	Specifies whether the icon order in the icon set rule is reversed.
SetScopeType	None	Sets the scope type for the conditional formatting rule.
SetShowIconOnly	boolean	Specifies whether to display only icons in the icon set rule (without cell values).
SetStopIfTrue	None	Sets whether the editor will stop evaluating additional formatting rules if this rule evaluates to true.
SetText	None	Sets the text value used in text-based conditional formatting rules.
SetTextOperator	None	Sets the text operator for text-based conditional formatting rules.