TreeListView.FormatConditionGeneratorTemplate Property

Gets or sets a template that describes conditional formats. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public DataTemplate FormatConditionGeneratorTemplate { get; set; }

VB.NET

Public Property FormatConditionGeneratorTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A conditional format template.

Remarks

You can define conditional formatting rules in a ViewModel and apply them to the GridControl. To do this, follow the steps below:

1. Create a collection of conditional formatting rules in a ViewModel.

2. Specify a data template that generates format conditions:

   XAML

   <Window.Resources>
       <DataTemplate x:Key="BackgroundTemplate">
           <ContentControl>
               <dxg:FormatCondition 
                   FieldName="{Binding Path=(dxci:DependencyObjectExtensions.DataContext).FieldName, RelativeSource={RelativeSource Self}}"
                   ValueRule="{Binding Path=(dxci:DependencyObjectExtensions.DataContext).Rule, RelativeSource={RelativeSource Self}, Converter={StaticResource FormatRuleConverter}}"
                   Value1="{Binding Path=(dxci:DependencyObjectExtensions.DataContext).Value, RelativeSource={RelativeSource Self}}"
                   ApplyToRow="{Binding Path=(dxci:DependencyObjectExtensions.DataContext).ApplyToRow, RelativeSource={RelativeSource Self}}"
                   PredefinedFormatName="LightRedFill"/>
           </ContentControl>
       </DataTemplate>
   </Window.Resources>
   

3. Assign the conditional formatting rule collection to the FormatConditionsSource property and the format condition template to the FormatConditionGeneratorTemplate property:

   XAML

   <dxg:GridControl ItemsSource="{Binding Orders}">
       <!-- ... -->
       <dxg:GridControl.View>
           <dxg:TreeListView FormatConditionsSource="{Binding Rules}"
                             FormatConditionGeneratorTemplate="{StaticResource BackgroundFormat}"/>
       </dxg:GridControl.View>
   </dxg:GridControl>
   

If you have multiple format condition templates, use the TreeListView.FormatConditionGeneratorTemplateSelector property to specify a template selector that chooses a template based on the format condition type.

Refer to the following help topic for more information: How to: Bind the Grid to a Collection of Conditional Formatting Rules.