FormatConditionBar Class

A format condition used to visualize numeric values using bars.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.2.Core.dll

Declaration

C#

public class FormatConditionBar :
    FormatConditionMinMaxBase

VB.NET

Public Class FormatConditionBar
    Inherits FormatConditionMinMaxBase

Remarks

To create a format condition to display bars with lengths proportional to corresponding values, do the following.

• Specify colors for bars corresponding to positive and negative numeric values using the FormatConditionBar.StyleSettings and FormatConditionBar.NegativeStyleSettings, respectively.
• If necessary, specify values corresponding to the shortest or longest bars using the FormatConditionMinMaxBase.Minimum and FormatConditionMinMaxBase.Maximum properties. Use the FormatConditionMinMaxBase.MinimumType and FormatConditionMinMaxBase.MaximumType properties to specify the type of these values.
• Optionally, specify options related to bar visualizing using the FormatConditionBar.BarOptions property.

Assign the resulting FormatConditionBar object to the DashboardItemFormatRule.Condition property.

Example

The Bar format condition (FormatConditionBar) allows you to visualize numeric values using bars.

This example shows how to display data bars within grid cells. Note that bars corresponding to positive and negative values are colored differently.

View Example

Form1.cs

using DevExpress.DashboardCommon;

namespace Grid_FormatRules {
    public partial class BarConditionForm : DevExpress.XtraEditors.XtraForm {
        public BarConditionForm() {
            InitializeComponent();
            Dashboard dashboard = new Dashboard(); dashboard.LoadFromXml(@"..\..\Data\Dashboard.xml");
            dashboardViewer1.Dashboard = dashboard;
            GridDashboardItem grid = (GridDashboardItem)dashboard.Items["gridDashboardItem1"];
            GridMeasureColumn extendedPrice = (GridMeasureColumn)grid.Columns[1];

            GridItemFormatRule barRule = new GridItemFormatRule(extendedPrice);
            FormatConditionBar barCondition = new FormatConditionBar();
            barCondition.StyleSettings = new BarStyleSettings(FormatConditionAppearanceType.PaleBlue);
            barCondition.NegativeStyleSettings = new BarStyleSettings(FormatConditionAppearanceType.PaleRed);
            barCondition.BarOptions.AllowNegativeAxis = checkBox1.Checked;
            barCondition.BarOptions.DrawAxis = checkBox2.Checked;
            barRule.Condition = barCondition;

            grid.FormatRules.AddRange(barRule);
        }

        private void checkBox1_CheckedChanged(object sender, System.EventArgs e) {
            UpdateBarOptions();
        }

        private void checkBox2_CheckedChanged(object sender, System.EventArgs e) {
            UpdateBarOptions();
        }

        private void checkBox3_CheckedChanged(object sender, System.EventArgs e) {
            UpdateBarOptions();
        }

        private void UpdateBarOptions() {
            GridDashboardItem grid = (GridDashboardItem)dashboardViewer1.Dashboard.Items[0];
            FormatConditionBarOptions barOptions = ((FormatConditionBar)(grid.FormatRules[0]).Condition).BarOptions;
            barOptions.AllowNegativeAxis = checkBox1.Checked;
            barOptions.DrawAxis = checkBox2.Checked;
            barOptions.ShowBarOnly = checkBox3.Checked;
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports DevExpress.DashboardCommon

Namespace Grid_FormatRules
    Partial Public Class BarConditionForm
        Inherits DevExpress.XtraEditors.XtraForm
        Public Sub New()
            InitializeComponent()
            Dim dashboard As New Dashboard()
            dashboard.LoadFromXml("..\..\Data\Dashboard.xml")
            dashboardViewer1.Dashboard = dashboard
            Dim grid As GridDashboardItem = CType(dashboard.Items("gridDashboardItem1"), GridDashboardItem)
            Dim extendedPrice As GridMeasureColumn = CType(grid.Columns(1), GridMeasureColumn)

            Dim barRule As New GridItemFormatRule(extendedPrice)
            Dim barCondition As New FormatConditionBar()
            barCondition.StyleSettings = New BarStyleSettings(FormatConditionAppearanceType.PaleBlue)
            barCondition.NegativeStyleSettings = New BarStyleSettings(FormatConditionAppearanceType.PaleRed)
            barCondition.BarOptions.AllowNegativeAxis = checkBox1.Checked
            barCondition.BarOptions.DrawAxis = checkBox2.Checked
            barRule.Condition = barCondition

            grid.FormatRules.AddRange(barRule)
        End Sub

        Private Sub checkBox1_CheckedChanged(ByVal sender As Object, ByVal e As System.EventArgs) Handles checkBox1.CheckedChanged
            UpdateBarOptions()
        End Sub

        Private Sub checkBox2_CheckedChanged(ByVal sender As Object, ByVal e As System.EventArgs) Handles checkBox2.CheckedChanged
            UpdateBarOptions()
        End Sub

        Private Sub checkBox3_CheckedChanged(ByVal sender As Object, ByVal e As System.EventArgs) Handles checkBox3.CheckedChanged
            UpdateBarOptions()
        End Sub

        Private Sub UpdateBarOptions()
            Dim grid As GridDashboardItem = CType(dashboardViewer1.Dashboard.Items(0), GridDashboardItem)
            Dim barOptions As FormatConditionBarOptions = (CType((grid.FormatRules(0)).Condition, FormatConditionBar)).BarOptions
            barOptions.AllowNegativeAxis = checkBox1.Checked
            barOptions.DrawAxis = checkBox2.Checked
            barOptions.ShowBarOnly = checkBox3.Checked
        End Sub
    End Class
End Namespace

Inheritance

Object

FormatConditionBase

FormatConditionStyleBase

FormatConditionMinMaxBase

FormatConditionBar