Format Class

Contains formatting settings for a value based conditional format.

Namespace: DevExpress.Xpf.Core.ConditionalFormatting

Assembly: DevExpress.Xpf.Core.v21.2.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public class Format :
    Freezable

VB.NET

Public Class Format
    Inherits Freezable

Related API Members

The following members return Format objects:

• DataUpdateFormatCondition.Format
• ExpressionConditionBase.Format
• ExpressionConditionBase.Format

Remarks

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

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

XAML

<dxg:TableView.FormatConditions> 
   <dxg:TopBottomRuleFormatCondition Rule="TopItems" Threshold="20" FieldName="Profit">
      <dx:Format Background="Purple"/> 
   </dxg:TopBottomRuleFormatCondition> 
</dxg:TableView.FormatConditions>

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

C#

var profitFormatCondition = new TopBottomRuleFormatCondition() {
   Rule = TopBottomRule.TopItems,
   Threshold = 20,    
   FieldName = "Profit", 
   Format = new Format() {
      Background = Brushes.Purple
   }
};
view.FormatConditions.Add(profitFormatCondition);

VB.NET

Dim profitFormatCondition = New TopBottomRuleFormatCondition() With {
   .Rule = TopBottomRule.TopItems,
   .Threshold = 20,
   .FieldName = "Profit",
   .Format = new Format() With {
      .Background = Brushes.Purple
   }
}
view.FormatConditions.Add(profitFormatCondition)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Format 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-disable-rows-based-on-their-values/CS/WpfApplication/MainWindow.xaml#L47

<dxg:FormatCondition.Format>
    <dx:Format Foreground="Gray" Background="LightGray"/>
</dxg:FormatCondition.Format>

how-to-use-scrollbar-annotations-t534664/CS/WpfApplication25/MainWindow.xaml#L32

<dxg:FormatCondition Expression="[Number] &gt; 2.0m and [Number] &lt; 4.0m" FieldName="Number" ApplyToRow="True">
    <dx:Format Background="Green"/>
</dxg:FormatCondition>

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

<dxg:FormatCondition Expression="[Profit] &lt; 0.0" FieldName="Profit">
    <dx:Format Foreground="Red"/>
</dxg:FormatCondition>

wpf-pivot-grid-apply-format-conditions-to-data-cells/CS/WpfPivotGridConditionalFormatting/MainWindow.xaml#L58

<dxpg:TopBottomRuleFormatCondition.Format>
    <dx:Format Background="LightGreen" Foreground="Green" />
</dxpg:TopBottomRuleFormatCondition.Format>

how-to-show-the-color-determined-by-conditional-formatting-when-a-row-is-focused-t423710/CS/DXSample/MainWindow.xaml#L20

                     FieldName="Discount">
    <dx:Format Background="LightGreen"/>
</dxg:FormatCondition>

Inheritance

Object

DispatcherObject

DependencyObject

Freezable

Format

Format