ColorScaleFormat Class

Contains formatting settings for a Color Scales conditional format.

Namespace: DevExpress.Xpf.Core.ConditionalFormatting

Assembly: DevExpress.Xpf.Core.v19.1.dll

Declaration

C#
VB.NET

public class ColorScaleFormat :
    IndicatorFormatBase

Public Class ColorScaleFormat
    Inherits IndicatorFormatBase

The following members return ColorScaleFormat objects:

Remarks

The ColorScaleFormat class instances are used to set the GridControl’s ColorScaleFormatCondition.Format and PivotGridControl’s ColorScaleFormatCondition.Format properties.

The following image shows the color scale formatting.

CFcolorscales

The code sample below illustrates how to create the color scale conditional formatting rule with a custom format in markup for GridControl.

XAML

<dxg:TableView.FormatConditions>
   <dxg:ColorScaleFormatCondition FieldName="Sales">
      <dx:ColorScaleFormat ColorMin="White" ColorMiddle="Green" ColorMax="Red"/>
   </dxg:ColorScaleFormatCondition>
</dxg:TableView.FormatConditions>

The code sample below illustrates how to define the same conditional formatting rule in code-behind for GridControl.

C#
VB.NET

var salesFormatCondition = new ColorScaleFormatCondition() {
   FieldName = "Sales",
   Format = new ColorScaleFormat() {
      ColorMin = Colors.White,
      ColorMiddle = Colors.Green,
      ColorMax = Colors.Red
   }
};
view.FormatConditions.Add(salesFormatCondition);

Dim salesFormatCondition = New ColorScaleFormatCondition() With {
   .FieldName = "Sales",
   .Format = new ColorScaleFormat() With {
      .ColorMin = Colors.White,
      .ColorMiddle = Colors.Green,
      .ColorMax = Colors.Red
   }
}
view.FormatConditions.Add(salesFormatCondition)

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

how-to-change-a-modified-cell-appearance-e4025/VB/DXGrid_ConditionalFormatting/Window1.xaml#L30

<dxg:ColorScaleFormatCondition FieldName="DeltaPrice">
    <dx:ColorScaleFormat ColorMin="Green" ColorMiddle="White" ColorMax="Red"/>
</dxg:ColorScaleFormatCondition>