How to: Apply a Data Bar Format to a Column

Nov 13, 2018
2 minutes to read

This example illustrates how to apply a data bar format to the Unit Price column in a GridControl at design time and in code.

Data bars fill column cells proportionally based on cell values relative to other cells. A longer bar corresponds to a higher value, and a shorter bar corresponds to a lower value.

To create a new formatting rule at design time, invoke the Format Rule Collection Editor from the Grid Designer. It can also be accessed from the Properties grid by clicking the ellipsis button for the ColumnView.FormatRules property.

Invoke the Grid Designer and switch to the Style Format Rules page (in the Appearance category).
Click the Add button to create a new format rule (format rules in a GridControl are encapsulated by GridFormatRule objects).
Select the Format using Data bar rule type. The format rule’s FormatRuleBase.Rule property will be set to a new FormatConditionRuleDataBar object.
Set the GridFormatRule.Column property to the Unit Price column. This column provides values to test against the formatting rule.
Choose one of the predefined bars styles using the FormatConditionRuleDataBar.PredefinedName property. You can do this in the Properties tab or the Rule tab. Additionally, the Rule tab allows you to see a preview of the selected style. In this example, the Blue Data Bar Gradient style is selected.
Run the application. The image below illustrates the result.

The following code is equivalent to the design-time actions shown above.

C#
VB.NET

csharp

using DevExpress.XtraEditors;
using DevExpress.XtraGrid;

GridFormatRule gridFormatRule = new GridFormatRule();
FormatConditionRuleDataBar formatConditionRuleDataBar = new FormatConditionRuleDataBar();
gridFormatRule.Column = this.colUnitPrice;
formatConditionRuleDataBar.PredefinedName = "Blue Gradient";
gridFormatRule.Rule = formatConditionRuleDataBar;
this.gridView.FormatRules.Add(gridFormatRule);

Imports DevExpress.XtraEditors
Imports DevExpress.XtraGrid

Dim gridFormatRule As New GridFormatRule()
Dim formatConditionRuleDataBar As New FormatConditionRuleDataBar()
gridFormatRule.Column = Me.colUnitPrice
formatConditionRuleDataBar.PredefinedName = "Blue Gradient"
gridFormatRule.Rule = formatConditionRuleDataBar
Me.gridView.FormatRules.Add(gridFormatRule)