IconSetFormatCondition Class

An Icon Sets conditional format.

Assembly: DevExpress.Xpf.Grid.v20.2.Core.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Grid.Core, DevExpress.Wpf.Grid.Core

Declaration

C#
VB.NET

public class IconSetFormatCondition :
    IndicatorFormatConditionBase

Public Class IconSetFormatCondition
    Inherits IndicatorFormatConditionBase

Remarks

The Icon Sets conditional format allows you to use predefined or custom sets of icons to format different ranges of values.

The image below shows a grid column whose Profit cells contain icons corresponding to numeric values.

CFIconSetsExample

To create the Icon Sets conditional format in code, create the IconSetFormatCondition class instance and specify the following settings:

Use the FormatConditionBase.FieldName property to specify the column’s field name to which to apply the conditional format.
Formatting cells/rows are based on single column values by default. Use the FormatConditionBase.Expression property to specify a complex custom expression that returns a value based on several parameters (e.g., several columns in a row).
Specify the target cells’ formatting in one of the following ways:
- Specify the predefined format using the FormatConditionBase.PredefinedFormatName property.
- Set the custom format using the IconSetFormatCondition.Format property.
Set a selective expression using the IndicatorFormatConditionBase.SelectiveExpression property if it is necessary to select data records to which the rule should be applied.
Add the resulting IconSetFormatCondition instance to the TableView.FormatConditions (or TreeListView.FormatConditions) collection.

The following code sample illustrates how to define a conditional format in markup:

XAML

<dxg:TableView.FormatConditions>
   <dxg:IconSetFormatCondition FieldName="Profit" PredefinedFormatName="Stars3IconSet"/>
</dxg:TableView.FormatConditions>

The code sample below illustrates how to define the same conditional format in code-behind:

C#
VB.NET

var profitFormatCondition = new IconSetFormatCondition() {
   FieldName = "Profit",
   PredefinedFormatName = "Stars3IconSet"
};
view.FormatConditions.Add(profitFormatCondition);

Dim profitFormatCondition = New IconSetFormatCondition() With {
   .FieldName = "Profit",
   .PredefinedFormatName = "Stars3IconSet"
}
view.FormatConditions.Add(profitFormatCondition)

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the IconSetFormatCondition 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.

XAML

wpf-data-grid-apply-conditional-formatting/CS/ConditionalFormatting/MainWindow.xaml#L33

<dxg:DataBarFormatCondition FieldName="Profit" PredefinedFormatName="GreenGradientDataBar"/>
<dxg:IconSetFormatCondition FieldName="MarketShare" PredefinedFormatName="Quarters5IconSet"/>
<dxg:IconSetFormatCondition FieldName="CustomersSatisfaction" PredefinedFormatName="Stars3IconSet"/>