Databar Interface

Definition

Namespace:

Microsoft.Office.Interop.Excel

Assembly:

Microsoft.Office.Interop.Excel.dll

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.

public interface class Databar

[System.Runtime.InteropServices.Guid("00024496-0000-0000-C000-000000000046")]
[System.Runtime.InteropServices.InterfaceType(2)]
public interface Databar

Public Interface Databar

Attributes

GuidAttribute InterfaceTypeAttribute

Examples

The following example creates a range of data and then applies a data bar to the range. You will notice that because there is an extremely low and high value in the range, the middle values have data bars that are of similiar length. To disambiguate the middle values, the sample code uses the ConditionValue object to change how the thresholds are evaluated to percentiles.

Remarks

All conditional formatting objects are contained within a FormatConditions collection object, which is a child of a Range collection. You can create a data bar formatting rule by using either the Add(XlFormatConditionType, Object, Object, Object, Object, Object, Object, Object) or AddDatabar() method of the FormatConditions collection.

You use the MinPoint and MaxPoint properties of the Databar object to set the values of the shortest bar and longest bar of a range of data. These properites return a ConditionValue object, in which you can specify how the thresholds are evaluated.

Properties

Application	When used without an object qualifier, this property returns an _Application object that represents the Microsoft Office Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object. Read-only.
AppliesTo	Returns a Range object specifying the cell range to which the formatting rule is applied.
AxisColor	Gets the color of the axis for cells with conditional formatting as data bars.
AxisPosition	Gets or sets the position of the axis of the data bars specified by a conditional formatting rule.
BarBorder	Gets an object that specifies the border of a data bar.
BarColor	Returns a FormatColor object that you can use to modify the color of the bars in a data bar conditional format.
BarFillType	Gets or sets how a data bar is filled with color.
Creator	Returns a constant in the XlCreator enumeration that indicates the application in which this object was created. Read-only.
Direction	Gets or sets the direction the databar is displayed.
Formula	Returns or sets a String representing a formula, which determines the values to which the icon set 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	Gets 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 Integer value that specifies the length of the longest data bar as a percentage of cell width.
PercentMin	Returns or sets a Integer 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 in a worksheet.
PTCondition	Returns a Boolean value indicating if the conditional format is being applied to a PivotTable chart. Read-only.
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 chart.
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. Read-only.

Methods

Delete()	Deletes the specified conditional formatting rule object.
ModifyAppliesToRange(Range)	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 it is evaluated after all other rules on the worksheet.