A format rule used to apply conditional formatting to the Grid dashboard item.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v19.2.Core.dll
public class GridItemFormatRule :
CellsItemFormatRulePublic Class GridItemFormatRule
Inherits CellsItemFormatRuleThe 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.
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.
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.
The complete sample project How to Apply the Value Format Conditional formatting to Grid Cells is available in the DevExpress Examples repository.
using DevExpress.DashboardCommon;
namespace Grid_ValueCondition {
public partial class Form1 : DevExpress.XtraEditors.XtraForm {
public Form1() {
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);
}
}
}
Imports DevExpress.DashboardCommon
Namespace Grid_ValueCondition
Partial Public Class Form1
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 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