FormatConditionGradientRangeBar Class

A format condition used to visualize numeric values using bars whose colors are contained in the specified color gradient.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public class FormatConditionGradientRangeBar :
    FormatConditionRangeGradient,
    IMinMaxInfo

VB.NET

Public Class FormatConditionGradientRangeBar
    Inherits FormatConditionRangeGradient
    Implements IMinMaxInfo

Remarks

Range gradient conditions allow you to apply formatting using value ranges and a specified color gradient. You can specify whether an absolute or percent scale is used to define range boundaries using the FormatConditionRangeBase.ValueType property.

To create a format condition to display bars of different colors (from the specified color gradient) with lengths proportional to corresponding values, use the following approaches.

1. To use a predefined set of start/end colors to create a color gradient, pass the required FormatConditionRangeGradientPredefinedType enumeration value to the FormatConditionRangeGradient constructor or to the corresponding FormatConditionGradientRangeBar.Generate method overload.
2. To use custom colors and a specified number of ranges to create color gradient, pass the required start/end colors (by initializing the BarStyleSettings object) and number of ranges to the FormatConditionRangeGradient constructor or to the corresponding FormatConditionGradientRangeBar.Generate method overload.
3. To use custom colors and specified range boundaries to create a color gradient, pass the required start/end colors (by initializing the BarStyleSettings object) and an array of boundary values to the FormatConditionRangeGradient constructor or to the corresponding FormatConditionGradientRangeBar.Generate method overload. You can also specify boundary values by calling the FormatConditionRangeBase.SetValues method.

4. To use custom range boundaries and the required style specified for each range, do the following.

   • Create the required number of RangeInfo objects that are the ranges containing boundary values (the RangeInfo.Value property), a comparison logic (RangeInfo.ValueComparison) and style setting applied to range values (RangeInfo.StyleSettings).
   • Add initialized RangeInfo objects to the FormatConditionRangeBase.RangeSet collection.

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

Example

The Bar Gradient Ranges condition (FormatConditionGradientRangeBar) allows you to visualize numeric values using bars whose colors are contained in the specified color gradient.

This example shows how to apply conditional formatting to Grid cells using the predefined Red-Blue color gradient. Click the Update Format Rule button to change start/end colors and the number of ranges in the color gradient. The third color in the middle of the color scale is also specified to generate a 3-color gradient.

View Example

Form1.cs

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
using DevExpress.XtraEditors;
using System.Drawing;

namespace Grid_FormatRules {
    public partial class RangeGradientBarConditionForm : XtraForm {
        public RangeGradientBarConditionForm() {
            InitializeComponent();
            dashboardViewer1.CustomizeDashboardTitle += DashboardViewer1_CustomizeDashboardTitle;
            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 rangeRule = new GridItemFormatRule(extendedPrice);
            FormatConditionGradientRangeBar rangeBarCondition =
                new FormatConditionGradientRangeBar(FormatConditionRangeGradientPredefinedType.BlueRed);
            rangeBarCondition.BarOptions.ShowBarOnly = true;
            rangeRule.Condition = rangeBarCondition;

            grid.FormatRules.AddRange(rangeRule);
        }

        private void DashboardViewer1_CustomizeDashboardTitle(object sender, CustomizeDashboardTitleEventArgs e)
        {
            DashboardToolbarItem itemUpdate = new DashboardToolbarItem((args) => UpdateFormatting()) {
                Caption = "Update Format Rule",
            };
            e.Items.Add(itemUpdate);
        }

        private void UpdateFormatting() {
            GridDashboardItem grid = (GridDashboardItem)dashboardViewer1.Dashboard.Items[0];
            GridItemFormatRule rangeRule = grid.FormatRules[0];

            FormatConditionGradientRangeBar rangeCondition =
                (FormatConditionGradientRangeBar)rangeRule.Condition;
            rangeCondition.Generate(new BarStyleSettings(Color.PaleVioletRed),
                                    new BarStyleSettings(Color.PaleGreen), 9);
            RangeInfo middleRange = rangeCondition.RangeSet[4];
            middleRange.StyleSettings = new BarStyleSettings(Color.SkyBlue);

            rangeRule.Condition = rangeCondition;
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
Imports DevExpress.XtraEditors
Imports System.Drawing

Namespace Grid_FormatRules
    Partial Public Class RangeGradientBarConditionForm
        Inherits XtraForm
        Public Sub New()
            InitializeComponent()
            AddHandler dashboardViewer1.CustomizeDashboardTitle, AddressOf DashboardViewer1_CustomizeDashboardTitle
            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 rangeRule As New GridItemFormatRule(extendedPrice)
            Dim rangeBarCondition As New FormatConditionGradientRangeBar(FormatConditionRangeGradientPredefinedType.BlueRed)
            rangeBarCondition.BarOptions.ShowBarOnly = True
            rangeRule.Condition = rangeBarCondition

            grid.FormatRules.AddRange(rangeRule)
        End Sub

        Private Sub DashboardViewer1_CustomizeDashboardTitle(ByVal sender As Object, ByVal e As CustomizeDashboardTitleEventArgs)
            Dim itemUpdate As New DashboardToolbarItem(Sub(args) UpdateFormatting()) With {.Caption = "Update Format Rule"}
            e.Items.Add(itemUpdate)
        End Sub

        Private Sub UpdateFormatting()
            Dim grid As GridDashboardItem = CType(dashboardViewer1.Dashboard.Items(0), GridDashboardItem)
            Dim rangeRule As GridItemFormatRule = grid.FormatRules(0)

            Dim rangeCondition As FormatConditionGradientRangeBar = CType(rangeRule.Condition, FormatConditionGradientRangeBar)
            rangeCondition.Generate(New BarStyleSettings(Color.PaleVioletRed), New BarStyleSettings(Color.PaleGreen), 9)
            Dim middleRange As RangeInfo = rangeCondition.RangeSet(4)
            middleRange.StyleSettings = New BarStyleSettings(Color.SkyBlue)

            rangeRule.Condition = rangeCondition
        End Sub
    End Class
End Namespace

Inheritance

Object

FormatConditionBase

FormatConditionRangeBase

FormatConditionRangeGradient

FormatConditionGradientRangeBar