ColorScaleFormatCondition Class

The Color Scales conditional format allows you to use predefined or custom sets of colors to format different ranges of values.

The image below shows a grid column whose Profit cells are colored according to their values.

To create the Color Scales conditional format in code, create the ColorScaleFormatCondition 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 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 ColorScaleFormatCondition instance to the TableView.FormatConditions (or TreeListView.FormatConditions) collection.

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

<dxg:TableView.FormatConditions>
   <dxg:ColorScaleFormatCondition FieldName="Profit" PredefinedFormatName="RedWhiteBlueColorScale"/>
</dxg:TableView.FormatConditions>

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

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

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

System.Object
    System.Windows.Threading.DispatcherObject
       System.Windows.DependencyObject
          FormatConditionBase
             IndicatorFormatConditionBase
                ColorScaleFormatCondition