TableView.FormatConditions Property

Stores conditional formats applied to the TableView.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v18.2.dll

Declaration

C#

public FormatConditionCollection FormatConditions { get; }

VB.NET

Public ReadOnly Property FormatConditions As FormatConditionCollection

Property Value

Type	Description
FormatConditionCollection	A FormatConditionCollection object that is the collection of conditional formats applied to the grid’s view.

Remarks

The FormatConditions collection stores conditional formatting rules applied to the grid’s view.

The following code sample illustrates how to define a conditional formatting rule in markup. See the How to: Apply Conditional Formatting example to learn more.

XAML

<dxg:TableView.FormatConditions>
   <dxg:DataBarFormatCondition FieldName="Visits" PredefinedFormatName="GreenGradientDataBar" />
</dxg:TableView.FormatConditions>

The code sample below illustrates how to define the same conditional formatting rule in code-behind. See the How to: Apply Conditional Formatting in Code-Behind example to learn more.

C#

var visitsDataBar = new DataBarFormatCondition() {
   FieldName = "Visits",
   PredefinedFormatName = "GreenGradientDataBar"
};
view.FormatConditions.Add(visitsDataBar);

VB.NET

Dim visitsDataBar = New DataBarFormatCondition() With {
   .FieldName = "Visits",
   .PredefinedFormatName = "GreenGradientDataBar"
}
view.FormatConditions.Add(visitsDataBar)

Use the following methods to remove conditional formatting rules:

• TableView.ClearFormatConditionsFromAllColumns - Removes all conditional formatting rules applied to the grid’s view.
• TableView.ClearFormatConditionsFromColumn - Removes conditional formatting rules for the specified column from the conditional format collection.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FormatConditions property.

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.

C#

wpf-data-grid-disable-rows-based-on-their-values/CS/WpfApplication/MainWindow.xaml#L52

<!--Just to highlight read-only cells-->
<dxg:TableView.FormatConditions>
    <dxg:FormatCondition Expression="![AllowEdit]">

how-to-use-a-custom-function-in-conditional-formatting-t167315/CS/CustomFilterOperationExample/MainWindow.xaml#L15

<dxg:TableView AllowConditionalFormattingMenu="True" x:Name="table1">
    <dxg:TableView.FormatConditions>
        <dxg:FormatCondition Expression="Function([FirstNum], [SecondNum], [TherdNum])">

how-to-colorize-rows-and-cells-by-using-conditional-expressions-e4256/CS/GridWithExpressions/MainWindow.xaml#L14

           AllowConditionalFormattingMenu="True">
<dxg:TableView.FormatConditions>
    <dxg:FormatCondition Expression="IsOutlookIntervalToday([FinishDate])"

how-to-apply-conditional-formatting-t135593/CS/ConditionalFormatting/MainWindow.xaml#L24

<dxg:TableView AllowEditing="False" AllowConditionalFormattingMenu="True">
    <dxg:TableView.FormatConditions>
        <dxg:FormatCondition Expression="[SalesVsTarget] &lt; 0.0m" FieldName="SalesVsTarget" PredefinedFormatName="RedText"/>

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

           CustomRowAppearance="TableView_CustomRowAppearance">
<dxg:TableView.FormatConditions>
    <dxg:FormatCondition ApplyToRow="True"