ColumnBase.CellTemplateSelector Property

Gets or sets an object that chooses a cell template based on custom logic. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public DataTemplateSelector CellTemplateSelector { get; set; }

VB.NET

Public Property CellTemplateSelector As DataTemplateSelector

Property Value

Type	Description
DataTemplateSelector	A DataTemplateSelector descendant that chooses a template based on custom logic.

Remarks

The ColumnBase.CellTemplate property specifies the template that defines the contents of a column cell. If you have more than one template to render cells, you can implement custom logic to choose the required template. To do this, derive from the DataTemplateSelector class and implement the SelectTemplate method that returns a template for each condition.

If you specify both the ColumnBase.CellTemplate and CellTemplateSelector, the CellTemplateSelector defines the cell template. If the template selector returns null, the template specified by the ColumnBase.CellTemplate property is used.

This sample illustrates how to use the CellTemplateSelector to change a cell template based on a condition:

View Example: How to change a cell template based on custom logic

To implement this task, do the following:

1. Implement custom DataTemplates. Editors declared in these templates should follow our recommendations from this help topic: ColumnBase.CellTemplate:

   Xaml

   <Window.Resources>
       <DataTemplate x:Key="booleanEditor">
           <dxe:CheckEdit Name="PART_Editor"/>
       </DataTemplate>
       <DataTemplate x:Key="buttonEditor">
           <dxe:ButtonEdit Name="PART_Editor"/>
       </DataTemplate>
       <DataTemplate x:Key="comboboxEditor">
           <dxe:ComboBoxEdit Name="PART_Editor">
               <dxe:ComboBoxEdit.ItemsSource>
                   <collections:ArrayList>
                       <dx:Alignment>Near</dx:Alignment>
                       <dx:Alignment>Center</dx:Alignment>
                       <dx:Alignment>Far</dx:Alignment>
                   </collections:ArrayList>
               </dxe:ComboBoxEdit.ItemsSource>
           </dxe:ComboBoxEdit>
       </DataTemplate>
       <DataTemplate x:Key="dateEditor">
           <dxe:DateEdit Name="PART_Editor"/>
       </DataTemplate>
       <DataTemplate x:Key="textEditor">
           <dxe:TextEdit Name="PART_Editor"/>
       </DataTemplate>
   </Window.Resources>
   
   <dxg:GridControl Name="grid">
       <dxg:GridControl.Columns>
           <dxg:GridColumn FieldName="Editor"/>
           <dxg:GridColumn FieldName="Value">
               <dxg:GridColumn.CellTemplateSelector>
                   <local:EditorTemplateSelector/>
               </dxg:GridColumn.CellTemplateSelector>
           </dxg:GridColumn>
       </dxg:GridControl.Columns>
       <dxg:GridControl.View>
           <dxg:TableView Name="view" AutoWidth="True" EditorButtonShowMode="ShowAlways"/>
       </dxg:GridControl.View>
   </dxg:GridControl> 
   

2. Create a custom DataTemplateSelector descendant. This descendant should return templates according to your scenario requirements.

   Note

   Each GridControl cell contains an object of the EditGridCellData data type in its DataContext. This object’s RowData.Row property contains your data item. You can use this property if your logic should take property values from data items into account:

   C#

   public class EditorTemplateSelector : DataTemplateSelector {
       public override DataTemplate SelectTemplate(object item, DependencyObject container) {
           EditGridCellData data = (EditGridCellData)item;
           var dataItem = data.RowData.Row as TestData;
           return string.IsNullOrEmpty(dataItem.Editor) ? null : (DataTemplate)((FrameworkElement)container).FindResource(dataItem.Editor);
       }
   } 
   

   VB.NET

   Public Class EditorTemplateSelector
       Inherits DataTemplateSelector
   
       Public Overrides Function SelectTemplate(ByVal item As Object, ByVal container As DependencyObject) As DataTemplate
           Dim data As EditGridCellData = DirectCast(item, EditGridCellData)
           Dim dataItem = TryCast(data.RowData.Row, TestData)
           Return If(String.IsNullOrEmpty(dataItem.Editor), Nothing, DirectCast(CType(container, FrameworkElement).FindResource(dataItem.Editor), DataTemplate))
       End Function
   End Class  
   

Data Binding

Cell elements contain EditGridCellData objects in their DataContext.

Use the following binding paths to access cell values, columns, and ViewModel properties:

• Value - access the current cell value;
• Column - access the current column;
• RowData.Row.[YourPropertyName] - access a property of an object from the ItemsSource collection;
• Data.[FieldName] - access column values in Server Mode or if you use the RealTimeSource, access unbound column values;
• View.DataContext.[YourPropertyName] - access a property in a grid’s ViewModel.

View Example: Build Binding Paths in WPF Data Grid Cells

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CellTemplateSelector 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.

XAML

wpf-data-grid-change-cell-template-based-on-custom-logic/CS/Window1.xaml#L43

<dxg:GridColumn FieldName="Value">
    <dxg:GridColumn.CellTemplateSelector>
        <local:EditorTemplateSelector />

wpf-data-grid-filter-columns-bound-to-collection-properties/CS/FilterDropDown_AgregateOperators/MainWindow.xaml#L26

<Setter Property="Width" Value="*"/>
<Setter Property="CellTemplateSelector">
    <Setter.Value>