ApiTop10

Class representing a top 10 conditional formatting rule.

ApiTop10 is a subclass of ApiFormatCondition.

Properties

Name	Type	Description
Percent	boolean	Returns or sets whether the top 10 ranking is percentage-based.
Rank	number	Returns or sets the rank value of the top 10 condition.
TopBottom	XlTopBottom	Returns or sets the "XlTopBottom" constant indicating whether the ranking is evaluated from the top or bottom.
Type	XlFormatConditionType	Returns the type of the top 10 conditional formatting rule.

Methods

The following table lists the available methods.

Method	Returns	Description
Delete	None	Deletes the top 10 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 | null	Returns the fill color for the top 10 conditional formatting rule.
GetFont	ApiFont	Returns the font formatting for the top 10 conditional formatting rule.
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.
GetNumberFormat	string	Returns the number format for the top 10 conditional formatting rule.
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.
GetPercent	boolean	Returns whether the top 10 ranking is percentage-based.
GetPriority	number	Returns the priority value of the conditional formatting rule.
GetRank	number	Returns the rank value for the top 10 condition.
GetScopeType	XlPivotConditionScope	Returns the scope type of the conditional formatting rule.
GetStopIfTrue	boolean	Returns whether the editor will stop evaluating additional formatting rules if this rule evaluates to true.
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.
GetTopBottom	XlTopBottom	Returns the "XlTopBottom" constant indicating whether the ranking is evaluated from the top or bottom.
GetType	XlFormatConditionType	Returns the type of the top 10 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 fill color for the top 10 conditional formatting rule.
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.
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 for the top 10 conditional formatting rule.
SetPercent	None	Sets whether the top 10 ranking is percentage-based.
SetPriority	None	Sets the priority value for the conditional formatting rule.
SetRank	None	Sets the rank value for the top 10 condition.
SetScopeType	None	Sets the scope type for the conditional formatting rule.
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.
SetTopBottom	None	Sets the "XlTopBottom" constant indicating whether the ranking is evaluated from the top or bottom.