FormatConditionCollection Class

A collection of conditional formats.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public class FormatConditionCollection :
    ObservableCollectionCore<FormatConditionBase>

VB.NET

Public Class FormatConditionCollection
    Inherits ObservableCollectionCore(Of FormatConditionBase)

Related API Members

The following members return FormatConditionCollection objects:

• FormatConditionBase.Owner
• TableView.FormatConditions
• TreeListView.FormatConditions

Remarks

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

Use the following methods to add and remove conditional formatting rules.

• TableView.AddFormatCondition / TreeListView.AddFormatCondition - Adds a conditional formatting rule to the conditional format collection.
• TableView.ClearFormatConditionsFromAllColumns / TreeListView.ClearFormatConditionsFromAllColumns - Removes all conditional formatting rules.
• TableView.ClearFormatConditionsFromColumn / TreeListView.ClearFormatConditionsFromColumn - Removes conditional formatting rules applied to the specified column.

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

XAML

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

View Example: Apply Conditional Formatting

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

C#

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

VB.NET

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

View Example: Apply Conditional Formatting in Code Behind

Inheritance

Object

Collection<FormatConditionBase>

ObservableCollection<FormatConditionBase>

DevExpress.Xpf.Core.ObservableCollectionCore<FormatConditionBase>

FormatConditionCollection