Class ColorScale (Excel VBA)

The class ColorScale represents a color scale conditional formatting rule.

The main procedures of class ColorScale are Delete, FormatConditions.Add, FormatConditions.AddAboveAverage, FormatConditions.AddColorScale, FormatConditions.AddDatabar, FormatConditions.AddIconSetCondition, FormatConditions.AddTop10, FormatConditions.AddUniqueValues and FormatConditions.Delete

Set

To use a ColorScale class variable it first needs to be instantiated, for example

Dim cse as ColorScale
Set cse = ActiveCell.FormatConditions(Index:=1)

The following procedures can be used to set variables of type ColorScale: FormatConditions.AddColorScale, FormatConditions.AddColorScale, FormatConditions.AddColorScale, FormatConditions.AddColorScale, FormatConditions.AddColorScale, FormatConditions.AddColorScale, FormatConditions.AddColorScale and Range.FormatConditions

For Each

Here is an example of processing the ColorScale items in a collection.

Dim cseFormatCondition As ColorScale
For Each cseFormatCondition In ActiveCell.FormatConditions
	
Next cseFormatCondition

Themes

The following procedures in this class have been grouped together and are described on a separate theme page

Add with its procedures FormatConditions.Add, FormatConditions.AddAboveAverage, FormatConditions.AddDatabar, FormatConditions.AddIconSetCondition and FormatConditions.AddTop10

Methods

These are the main methods of the ColorScale class

Delete - Deletes the specified conditional formatting rule object.

ActiveCell.FormatConditions(1).Delete

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.

ActiveCell.FormatConditions.Delete

Other Methods

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.Item - Returns a single object from a collection.

Properties

AppliesTo returns a Range object specifying the cell range to which the formatting rule is applied.

ColorScaleCriteria returns a ColorScaleCriteria object, which is a collection of individual ColorScaleCriterion objects. The ColorScaleCriterion object specifies the type, value, and color of threshold criteria used in the color scale conditional format.

Formula returns or sets a String representing a formula that determines the values to which the icon set will be applied.

Parent returns the parent object for the specified object. Read-only.

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.

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.

Type returns one of the constants of the XlFormatConditionType enumeration, which specifies the type of conditional format.

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.