The requested page is not available for the requested platform. You are viewing the content for Default platform.

Conditional Formatting

  • 3 min to read

The DevExpress Dashboard allows you to format dashboard item elements whose values meet a specified condition. This feature highlights specific elements with a predefined set of rules.

conditional-formatting-common

Conditional Formatting Overview

Comparison rules used in conditional formatting can be divided into the following groups.

Format Condition

Description

Example

Condition class

Value

Allows you to compare static values (such as Greater Than, Less Than, Between, etc.).

GreaterThanCondition_Common

Desktop: FormatConditionValue

Web: FormatConditionValue

Top-Bottom

Highlights a specific number of topmost/bottommost values.

TopNFormatCondition_Common

Desktop: FormatConditionTopBottom

Web: FormatConditionTopBottom

Average

Highlights values above and below an average.

BelowAverageCondition_Common

Desktop: FormatConditionAverage

Web: FormatConditionAverage

A Date Occurring

Allows you to highlight date-time values that fall into a specified interval relative to the current date.

DateOccurring_Common

Desktop: FormatConditionDateOccurring

Web: FormatConditionDateOccurring

Expression

Allows you to use complex conditions to apply formatting. You can also pass dashboard parameters to expressions.

ExpressionCondition_Common

Desktop: FormatConditionExpression

Web: FormatConditionExpression

Icon Ranges

Allows you to apply formatting by displaying specific icons for different ranges of values. You can select a predefined set of icons or use a specific icon for each range.

IconRange_Common

Desktop: FormatConditionRangeSet

Web: FormatConditionRangeSet

Color Ranges

Allows you to apply formatting using specific colors for different ranges of values. You can select a predefined set of colors or use custom appearance settings to highlight values within specified ranges.

ColorRange_Common

Desktop: FormatConditionRangeSet

Web: FormatConditionRangeSet

Gradient Ranges

Allows you to apply formatting using gradient color scales.

GradientRange_Common

Desktop: FormatConditionRangeGradient

Web: FormatConditionRangeGradient

Bar

Allows you to visualize numeric values using bars. You can also color bars corresponding to positive and negative values using different colors.

BarCondition_Common

Desktop: FormatConditionBar

Web: FormatConditionBar

Bar Color Ranges

Allows you to visualize numeric values using bars whose colors are contained in the specified color set.

ColorRangeBar_Common

Desktop: FormatConditionColorRangeBar

Web: FormatConditionColorRangeBar

Bar Gradient Ranges

Allows you to visualize numeric values using bars whose colors are contained in the specified color gradient.

BarGradientRanges_Common

Desktop: FormatConditionGradientRangeBar

Web: FormatConditionGradientRangeBar

You can apply conditional formatting to measure or dimension values. The table below lists format conditions that can be applied to different types of data items.

Data Item

Supported Format Conditions

Measure/numeric Dimension

Value

Top-Bottom

Average

Expression

Icon Ranges

Color Ranges

Gradient Ranges

Bar

Bar Color Ranges

Bar Gradient Ranges

string Dimension

Value with the condition type set to Equal To, Not Equal To or Text that Contains

Expression

date-time Dimension

Value

A Date Occurring for dimensions with the continuous date-time group interval

Expression

Icon Ranges

Color Ranges

Gradient Ranges

Bar

Bar Color Ranges

Bar Gradient Ranges

How to Apply Conditional Formatting in UI

The topics below describe how to use conditional formatting in the WinForms Designer and on the web.

How to Apply Conditional Formatting in Code

Dashboard items that support conditional formatting expose the FormatRules property providing access to a collection of the DashboardItemFormatRule descendants.

To create a new rule, do the following.

Finally, add the created format rule to the FormatRules collection exposed by the dashboard item. To learn more, see the Conditional Formatting topic for the required dashboard item.