FormatConditionValue Class
A format condition used to apply formatting according to predefined values.
Namespace: DevExpress.DashboardCommon
Assembly: DevExpress.Dashboard.v22.1.Core.dll
Declaration
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.
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);
}
}
}
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.