FormatConditionValue Class

A format condition used to apply formatting according to predefined values.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public class FormatConditionValue :
    FormatConditionStyleBase

VB.NET

Public Class FormatConditionValue
    Inherits FormatConditionStyleBase

Remarks

To create a format condition to apply formatting according to predefined values, do the following.

• Specify the comparison logic by setting the FormatConditionValue.Condition property.
• Specify boundary values using the FormatConditionValue.Value1/FormatConditionValue.Value2 properties.
• Specify the required style settings applied to target elements using the FormatConditionStyleBase.StyleSettings property. You can change the color of dashboard item elements, font settings (AppearanceSettings) or add predefined icons (IconSettings).

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

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 FormatConditionValue 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-the-card-dashboard-item/CS/CardFormatRulesSample/Form1.cs#L26

backColorStyleRule.ApplyToLayoutElement = CardFormatRuleLayoutElement.ActualValue;
FormatConditionValue valueCondition = new FormatConditionValue(DashboardFormatCondition.Equal, "Chain");
valueCondition.StyleSettings = new AppearanceSettings(Color.LightGreen);

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

GridItemFormatRule lessThanRule = new GridItemFormatRule(extendedPrice);
FormatConditionValue lessThanCondition = new FormatConditionValue();
lessThanCondition.Condition = DashboardFormatCondition.LessOrEqual;

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

GridItemFormatRule lessThanRule = new GridItemFormatRule(extendedPrice);
FormatConditionValue lessThanCondition = new FormatConditionValue();
lessThanCondition.Condition = DashboardFormatCondition.LessOrEqual;

WinForms-Dashboard-How-to-Apply-Conditional-Formatting-to-the-Chart-Dashboard-Item/CS/ChartFormatRulesSample/Form1.cs#L35

ChartItemFormatRule valueRule1 = new ChartItemFormatRule(series.Value, series);
FormatConditionValue valueCondition1 = new FormatConditionValue(DashboardFormatCondition.Greater, 3000);
valueCondition1.StyleSettings = new ColorStyleSettings(Color.Green);

how-to-apply-conditional-formatting-to-pivot-cells-t267344/CS/Pivot_ConditionalFormatting/Form1.cs#L13

PivotItemFormatRule firstLevelRule = new PivotItemFormatRule(pivot.Values[0]);
FormatConditionValue greaterThanCondition = new FormatConditionValue();
greaterThanCondition.Condition = DashboardFormatCondition.Greater;

VB.NET

how-to-apply-conditional-formatting-to-the-card-dashboard-item/VB/CardFormatRulesSample/Form1.vb#L28

backColorStyleRule.ApplyToLayoutElement = CardFormatRuleLayoutElement.ActualValue
Dim valueCondition As New FormatConditionValue(DashboardFormatCondition.Equal, "Chain")
valueCondition.StyleSettings = New AppearanceSettings(Color.LightGreen)

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

Dim lessThanRule As New GridItemFormatRule(extendedPrice)
Dim lessThanCondition As New FormatConditionValue()
lessThanCondition.Condition = DashboardFormatCondition.LessOrEqual

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

Dim lessThanRule As New GridItemFormatRule(extendedPrice)
Dim lessThanCondition As New FormatConditionValue()
lessThanCondition.Condition = DashboardFormatCondition.LessOrEqual

WinForms-Dashboard-How-to-Apply-Conditional-Formatting-to-the-Chart-Dashboard-Item/VB/ChartFormatRulesSample/Form1.vb#L37

Dim valueRule1 As New ChartItemFormatRule(series.Value, series)
Dim valueCondition1 As New FormatConditionValue(DashboardFormatCondition.Greater, 3000)
valueCondition1.StyleSettings = New ColorStyleSettings(Color.Green)

how-to-apply-conditional-formatting-to-pivot-cells-t267344/VB/Pivot_ConditionalFormatting/Form1.vb#L15

Dim firstLevelRule As New PivotItemFormatRule(pivot.Values(0))
Dim greaterThanCondition As New FormatConditionValue()
greaterThanCondition.Condition = DashboardFormatCondition.Greater

Inheritance

Object

FormatConditionBase

FormatConditionStyleBase

FormatConditionValue