Class Top10 (Excel VBA)
The class Top10 represents a top ten visual of a conditional formatting rule. Applying a color to a range helps you see the value of a cell relative to other cells.
The main procedures of class Top10 are FormatConditions.Add, FormatConditions.AddAboveAverage, FormatConditions.AddColorScale, FormatConditions.AddDatabar, FormatConditions.AddIconSetCondition, FormatConditions.AddTop10, FormatConditions.AddUniqueValues, FormatConditions.Delete and Delete
To use a Top10 class variable it first needs to be instantiated, for example
Dim tp1 as Top10 Set tp1 = ActiveCell.FormatConditions(Index:=1)
The following procedures can be used to set variables of type Top10: Range.FormatConditions, FormatConditions.AddTop10, FormatConditions.AddTop10, FormatConditions.AddTop10, FormatConditions.AddTop10, FormatConditions.AddTop10, FormatConditions.AddTop10 and FormatConditions.AddTop10
Here is an example of processing the Top10 items in a collection.
Dim tp1FormatCondition As Top10 For Each tp1FormatCondition In ActiveCell.FormatConditions Next tp1FormatCondition
The following procedures in this class have been grouped together and are described on a separate theme page
These are the main methods of the Top10 class
FormatConditions.AddColorScale - Returns a new ColorScale colorscale representing a conditional formatting rule that uses gradations in cell colors to indicate relative differences in the values of cells included in a selected range.
Dim lngColorScaleType As Long: lngColorScaleType = Dim cseAddColorScale As ColorScale Set cseAddColorScale = ActiveCell.FormatConditions.AddColorScale(ColorScaleType:=lngColorScaleType)
FormatConditions.AddUniqueValues - Returns a new UniqueValues uniquevalues representing a conditional formatting rule for the specified range.
Dim uvsAddUniqueValues As UniqueValues Set uvsAddUniqueValues = ActiveCell.FormatConditions.AddUniqueValues()
FormatConditions.Delete - Deletes the object.
Delete - Deletes the specified conditional formatting rule object.
FormatConditions.Item - Returns a single object from a collection.
ModifyAppliesToRange - Sets the cell range to which this formatting rule applies.
SetFirstPriority - Sets the priority value for this conditional formatting rule to 1 so that it will be evaluated before all other rules on the worksheet.
SetLastPriority - Sets the evaluation order for this conditional formatting rule so that it is evaluated after all other rules on the worksheet.
FormatConditions.Count returns a Long value that represents the number of objects in the collection.
FormatConditions.Parent returns the parent object for the specified object. Read-only.
AppliesTo returns a Range object specifying the cell range to which the formatting rule is applied.
Borders returns a Borders collection that specifies the formatting of cell borders if the conditional formatting rule evaluates to True.
CalcFor returns or sets one of the constants of the XlCalcFor enumeration, which specifies how the conditional format in a PivotTable report should be evaluated.
Font returns a Font object that specifies the font formatting if the conditional formatting rule evaluates to True.
Interior returns an Interior object that specifies a cell's interior attributes for a conditional formatting rule that evaluates to True.
NumberFormat returns or sets the number format applied to a cell if the conditional formatting rule evaluates to True.
Parent returns the parent object for the specified object. Read-only.
Percent returns or sets a Boolean value, specifying if the rank is determined by a percentage value.
Priority returns or sets the priority value of the conditional formatting rule. The priority determines the order of evaluation when multiple conditional formatting rules exist on a worksheet.
PTCondition returns a Boolean value indicating if the conditional format is being applied to a PivotTable.
Rank returns or sets a Long value, specifying either the number or percentage of the rank value for the conditional formatting rule.
ScopeType returns or sets one of the constants of the XlPivotConditionScope enumeration, which determines the scope of the conditional format when it is applied to a PivotTable.
StopIfTrue returns or sets a Boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.
TopBottom returns or sets one of the constants of the XlTopBottom enumeration, which determines if the ranking is evaluated from the top or bottom.
Type returns one of the constants of the XlFormatConditionType enumeration, which specifies the type of conditional format.