Class Databar (Excel VBA)
The class Databar represents a data bar conditional formating rule. Applying a data bar to a range helps you see the value of a cell relative to other cells.
The main procedures of class Databar are Delete, FormatConditions.Add, FormatConditions.AddAboveAverage, FormatConditions.AddColorScale, FormatConditions.AddDatabar, FormatConditions.AddIconSetCondition, FormatConditions.AddTop10, FormatConditions.AddUniqueValues and FormatConditions.Delete
To use a Databar class variable it first needs to be instantiated, for example
Dim dtb as Databar Set dtb = ActiveCell.FormatConditions(Index:=1)
The following procedures can be used to set variables of type Databar: FormatConditions.AddDatabar, FormatConditions.AddDatabar, FormatConditions.AddDatabar, FormatConditions.AddDatabar, FormatConditions.AddDatabar, FormatConditions.AddDatabar, FormatConditions.AddDatabar and Range.FormatConditions
Here is an example of processing the Databar items in a collection.
Dim dtbFormatCondition As Databar For Each dtbFormatCondition In ActiveCell.FormatConditions Next dtbFormatCondition
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 Databar class
Delete - Deletes the specified conditional formatting rule object.
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.
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.
AppliesTo returns a Range object specifying the cell range to which the formatting rule is applied.
AxisColor returns the color of the axis for cells with conditional formatting as data bars. Read-only.
AxisPosition returns or sets the position of the axis of the data bars specified by a conditional formatting rule.
BarBorder returns an object that specifies the border of a data bar.
BarColor returns a FormatColor formatcolor that you can use to modify the color of the bars in a data bar conditional format.
BarFillType returns or sets how a data bar is filled with color.
Direction returns or sets the direction that the databar is displayed.
Formula returns or sets a String representing a formula, which determines the values to which the data bar will be applied.
MaxPoint returns a ConditionValue object that specifies how the longest bar is evaluated for a data bar conditional format.
MinPoint returns a ConditionValue object that specifies how the shortest bar is evaluated for a data bar conditional format.
NegativeBarFormat returns the NegativeBarFormat object associated with a data bar conditional formatting rule.
Parent returns the parent object for the specified object. Read-only.
PercentMax returns or sets a Long value that specifies the length of the longest data bar as a percentage of cell width.
PercentMin returns or sets a Long value that specifies the length of the shortest data bar as a percentage of cell width.
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.
ShowValue returns or sets a Boolean value that specifies if the value in the cell is displayed if the data bar conditional format is applied to the range.
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.