ColumnBase.CellTemplate Property

Gets or sets the template that defines the presentation of column cells. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

Declaration

C#

public DataTemplate CellTemplate { get; set; }

VB.NET

Public Property CellTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A DataTemplate object that defines the presentation of column cells.

Remarks

Use the CellTemplate property to define a template that specifies the visualization of column cells. The binding source for the CellTemplate template is represented by the GridCellData class.

The code sample belows shows how to use a custom ComboBoxEdit within grid cells:

Xaml

<dxg:GridControl AutoGenerateColumns="AddNew" EnableSmartColumnsGeneration="True" ItemsSource="{Binding Items}">
    <dxg:GridColumn FieldName="Country"/>
    <dxg:GridColumn FieldName="City">
        <dxg:GridColumn.CellTemplate>
            <DataTemplate>
                <dxe:ComboBoxEdit x:Name="PART_Editor" ItemsSource="{Binding RowData.Row.Cities}"/>
            </DataTemplate>
        </dxg:GridColumn.CellTemplate>
    </dxg:GridColumn>
    <dxg:GridControl.View>
        <dxg:TableView/>
    </dxg:GridControl.View>
</dxg:GridControl>

C#

public ObservableCollection<CountryCities> Items {
    get {
        if(this._Items == null) {
            this._Items = new ObservableCollection<CountryCities>();

            CountryCities usa = new CountryCities() {
                Country = "USA",
                Cities = new List<string> { "Washington, D.C.", "New York", "Los Angeles", "Las Vegas" },
                City = "Los Angeles"
            };
            this._Items.Add(usa);

            CountryCities germany = new CountryCities() {
                Country = "Germany",
                Cities = new List<string> { "Berlin", "Munich", "Frankfurt" },
                City = "Munich"
            };
            this._Items.Add(germany);

            CountryCities russia = new CountryCities() {
                Country = "Russia",
                Cities = new List<string> { "Moscow", "Saint-Petersburg" },
                City = "Moscow"
            };
            this._Items.Add(russia);
        }
        return this._Items;
    }
} 

VB.NET

Public ReadOnly Property Items As ObservableCollection(Of CountryCities)
    Get

        If Me._Items Is Nothing Then
            Me._Items = New ObservableCollection(Of CountryCities)()
            Dim usa As CountryCities = New CountryCities() With {
                .Country = "USA",
                .Cities = New List(Of String) From {
                    "Washington, D.C.",
                    "New York",
                    "Los Angeles",
                    "Las Vegas"
                },
                .City = "Los Angeles"
            }
            Me._Items.Add(usa)
            Dim germany As CountryCities = New CountryCities() With {
                .Country = "Germany",
                .Cities = New List(Of String) From {
                    "Berlin",
                    "Munich",
                    "Frankfurt"
                },
                .City = "Munich"
            }
            Me._Items.Add(germany)
            Dim russia As CountryCities = New CountryCities() With {
                .Country = "Russia",
                .Cities = New List(Of String) From {
                    "Moscow",
                    "Saint-Petersburg"
                },
                .City = "Moscow"
            }
            Me._Items.Add(russia)
        End If

        Return Me._Items
    End Get
End Property 

Tip

• For the DevExpress Data Editors (the BaseEdit class’s descendants), you can set the editor’s Name property to PART_Editor. In this case, the GridControl automatically adjusts its appearance and synchronizes the editor with the source field specified by the ColumnBase.FieldName or ColumnBase.Binding properties.
• You can use any binding with an editor named PART_Editor. In this case, the GridControl‘s logic of getting/setting the editor’s value is disabled.
• You can specify the following validation binding properties: ValidatesOnDataErrors, ValidatesOnExceptions, NotifyOnValidationError, and NotifyOnSourceUpdated.

Tip

A template that defines the presentation of data cells is specified by the CellTemplate property. If you have more than one template that can be used to render cells, you can implement custom logic to choose the required template. To do this, derive from the DataTemplateSelector class, implement the SelectTemplate method that returns a template which meets the required condition, and assign it to the ColumnBase.CellTemplateSelector property.

If both the CellTemplate and ColumnBase.CellTemplateSelector are specified, a cell is rendered using the template returned by the template selector. If the template selector returns null, the template specified by the CellTemplate property is used.

Note

When using the CellTemplate, an editor specified with the ColumnBase.EditSettings property is ignored (but its formatting settings persist).

Note

Editors specified in the CellTemplate do not affect data processing (sorting, grouping, filtering, summary calculation) and export.

Use the PrintCellStyle property to customize cell appearance when printing and exporting the GridControl‘s data.

The GridControl.CustomColumnDisplayText allows you to display custom text within any cell. The provided text provided is used when the grid is printed.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CellTemplate 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-gridcontrol-populate-inplace-comboboxedit-with-values-based-on-values-from-other-cells/CS/MainWindow.xaml#L25

<dxg:GridColumn FieldName="Color">
    <dxg:GridColumn.CellTemplate>
        <DataTemplate>

dxgrid-keyboard-navigation-integration-with-autocompletebox-e20032/CS/keyboardNavigation/MainWindow.xaml#L15

<dxg:GridColumn FieldName="Value" Name="ValueColumn">
    <dxg:GridColumn.CellTemplate>
        <DataTemplate>

how-to-build-binding-paths-in-gridcontrol-cells/VB/MainWindow.xaml#L22

<dxg:GridColumn FieldName="Country">
    <dxg:GridColumn.CellTemplate>
        <DataTemplate>

how-to-embed-animation-into-grid-cells-e1532/CS/AnimateCells/Window1.xaml#L29

<dxg:GridColumn FieldName="Name" />
<dxg:GridColumn FieldName="Speed" Header="Speed (mph)" FixedWidth="True" Width="200" CellTemplate="{StaticResource speedTemplate}" />
<dxg:GridColumn FieldName="Distance" Header="Distance (m)" FixedWidth="True" Width="100" EditSettings="{dxe:TextSettings DisplayFormat=0.00}" />

how-to-select-data-rows-e1666/CS/DXGrid_RowSelection/Window1.xaml#L37

<dxg:GridControl.Columns>
    <dxg:GridColumn x:Name="col" FieldName="ProductName" CellTemplate="{StaticResource cellTemplate}" />
    <dxg:GridColumn FieldName="UnitPrice" />

VB.NET

how-to-customize-automatically-generated-columns-e2019/VB/E2019/Window1.xaml.vb#L20

Case "IssueName"
    column.CellTemplate = TryCast(Application.Current.MainWindow.Resources("IssueNameTemplate"), DataTemplate)
    column.SortOrder = DevExpress.Data.ColumnSortOrder.Ascending