GridItemFormatRule Class

A format rule used to apply conditional formatting to the Grid dashboard item.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class GridItemFormatRule :
    CellsItemFormatRule

VB.NET

Public Class GridItemFormatRule
    Inherits CellsItemFormatRule

Remarks

The Grid dashboard item allows you to apply conditional formatting to cells. The GridDashboardItem.FormatRules property provides access to a collection of the GridItemFormatRule objects that are used to define formatting settings.

To add a new format rule, create the GridItemFormatRule object and specify the following settings.

• Create a required condition (the FormatConditionBase descendant), specify its settings and assign the resulting object to the DashboardItemFormatRule.Condition property.
• Set a measure/dimension whose values are checked using the specified condition by specifying the CellsItemFormatRule.DataItem property. The CellsItemFormatRule.DataItemApplyTo property specifies the measure/dimension to whose values a formatting should be applied.
• Optionally, enable the CellsItemFormatRule.ApplyToRow flag to apply formatting to the entire grid row.

Finally, add the created format rule to the GridDashboardItem.FormatRules collection. You can use the DashboardItemFormatRule.Enabled property to specify whether the current format rule is enabled.

Example

The Value format condition (FormatConditionValue) allows you to compare dimension/measure values with predefined static values.

This example demonstrates how to apply conditional formatting to Grid cells whose values are greater than, less than or between the specified values.

View Example

Form1.cs

using DevExpress.DashboardCommon;
using DevExpress.XtraEditors;

namespace Grid_FormatRules {
    public partial class ValueConditionForm : XtraForm {
        public ValueConditionForm() {
            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 lessThanRule = new GridItemFormatRule(extendedPrice);
            FormatConditionValue lessThanCondition = new FormatConditionValue();
            lessThanCondition.Condition = DashboardFormatCondition.LessOrEqual;
            lessThanCondition.Value1 = 100000;
            lessThanCondition.StyleSettings = 
                new AppearanceSettings(FormatConditionAppearanceType.FontRed);
            lessThanRule.Condition = lessThanCondition;

            GridItemFormatRule betweenRule = new GridItemFormatRule(extendedPrice);
            FormatConditionValue betweenCondition = new FormatConditionValue();
            betweenCondition.Condition = DashboardFormatCondition.Between;
            betweenCondition.Value1 = 100000;
            betweenCondition.Value2 = 200000;
            betweenCondition.StyleSettings = 
                new AppearanceSettings(FormatConditionAppearanceType.FontYellow);
            betweenRule.Condition = betweenCondition;

            GridItemFormatRule greaterThanRule = new GridItemFormatRule(extendedPrice);
            FormatConditionValue greaterThanCondition = new FormatConditionValue();
            greaterThanCondition.Condition = DashboardFormatCondition.GreaterOrEqual;
            greaterThanCondition.Value1 = 200000;
            greaterThanCondition.StyleSettings = 
                new AppearanceSettings(FormatConditionAppearanceType.FontGreen);
            greaterThanRule.Condition = greaterThanCondition;

            grid.FormatRules.AddRange(lessThanRule, betweenRule, greaterThanRule);
        }
    }
}

Form1.vb

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

Namespace Grid_FormatRules
    Partial Public Class ValueConditionForm
        Inherits 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 lessThanRule As New GridItemFormatRule(extendedPrice)
            Dim lessThanCondition As New FormatConditionValue()
            lessThanCondition.Condition = DashboardFormatCondition.LessOrEqual
            lessThanCondition.Value1 = 100000
            lessThanCondition.StyleSettings = New AppearanceSettings(FormatConditionAppearanceType.FontRed)
            lessThanRule.Condition = lessThanCondition

            Dim betweenRule As New GridItemFormatRule(extendedPrice)
            Dim betweenCondition As New FormatConditionValue()
            betweenCondition.Condition = DashboardFormatCondition.Between
            betweenCondition.Value1 = 100000
            betweenCondition.Value2 = 200000
            betweenCondition.StyleSettings = New AppearanceSettings(FormatConditionAppearanceType.FontYellow)
            betweenRule.Condition = betweenCondition

            Dim greaterThanRule As New GridItemFormatRule(extendedPrice)
            Dim greaterThanCondition As New FormatConditionValue()
            greaterThanCondition.Condition = DashboardFormatCondition.GreaterOrEqual
            greaterThanCondition.Value1 = 200000
            greaterThanCondition.StyleSettings = New AppearanceSettings(FormatConditionAppearanceType.FontGreen)
            greaterThanRule.Condition = greaterThanCondition

            grid.FormatRules.AddRange(lessThanRule, betweenRule, greaterThanRule)
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GridItemFormatRule class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-apply-conditional-formatting-to-grid-cells-in-win-dashboard/CS/Dashboard_ConditionalFormatting_Grid/BarConditionForm.cs#L12

GridItemFormatRule barRule = new GridItemFormatRule(extendedPrice);
FormatConditionBar barCondition = new FormatConditionBar();

how-to-apply-conditional-formatting-to-grid-cells-using-the-top-bottom-average-conditions-t259930/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L14

GridItemFormatRule topRule = new GridItemFormatRule(extendedPrice, salesPerson);
FormatConditionTopBottom topCondition = new FormatConditionTopBottom();

how-to-apply-conditional-formatting-to-grid-cells-using-the-value-format-condition-t259897/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L12

GridItemFormatRule lessThanRule = new GridItemFormatRule(extendedPrice);
FormatConditionValue lessThanCondition = new FormatConditionValue();

how-to-apply-conditional-formatting-to-grid-cells-using-the-icon-ranges-format-condition-t259991/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L14

GridItemFormatRule rangeRule = new GridItemFormatRule(extendedPrice);
FormatConditionRangeSet rangeCondition =

how-to-apply-conditional-formatting-to-grid-cells-using-the-gradient-ranges-condition-t260005/CS/Dashboard_ConditionalFormatting_Grid/Form1.cs#L16

GridItemFormatRule rangeRule = new GridItemFormatRule(extendedPrice);
FormatConditionRangeGradient rangeCondition =

VB.NET

how-to-apply-conditional-formatting-to-grid-cells-in-win-dashboard/VB/Dashboard_ConditionalFormatting_Grid/BarConditionForm.vb#L16

Dim barRule As New GridItemFormatRule(extendedPrice)
Dim barCondition As New FormatConditionBar()

how-to-apply-conditional-formatting-to-grid-cells-using-the-top-bottom-average-conditions-t259930/VB/Dashboard_ConditionalFormatting_Grid/Form1.vb#L17

Dim topRule As New GridItemFormatRule(extendedPrice, salesPerson)
Dim topCondition As New FormatConditionTopBottom()

how-to-apply-conditional-formatting-to-grid-cells-using-the-value-format-condition-t259897/VB/Dashboard_ConditionalFormatting_Grid/Form1.vb#L15

Dim lessThanRule As New GridItemFormatRule(extendedPrice)
Dim lessThanCondition As New FormatConditionValue()

how-to-apply-conditional-formatting-to-grid-cells-using-the-icon-ranges-format-condition-t259991/VB/Dashboard_ConditionalFormatting_Grid/Form1.vb#L17

Dim rangeRule As New GridItemFormatRule(extendedPrice)
Dim rangeCondition As New FormatConditionRangeSet(FormatConditionRangeSetPredefinedType.PositiveNegative3)

how-to-apply-conditional-formatting-to-grid-cells-using-the-gradient-ranges-condition-t260005/VB/Dashboard_ConditionalFormatting_Grid/Form1.vb#L18

Dim rangeRule As New GridItemFormatRule(extendedPrice)
Dim rangeCondition As New FormatConditionRangeGradient(FormatConditionRangeGradientPredefinedType.RedBlue)

Inheritance

Object

DashboardItemFormatRule

CellsItemFormatRule

GridItemFormatRule