DataViewBase.CellEditTemplate Property

Gets or sets a template that displays a custom editor used to edit column values. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

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

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public DataTemplate CellEditTemplate { get; set; }

VB.NET

Public Property CellEditTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A template that displays a custom editor.

Remarks

The binding source for the CellEditTemplate template is represented by the EditGridCellData class.

In-place editors are used for both presenting data and editing records. You can use separate in-place editors for both tasks. Each column provides two templates that allow you to define custom editors that display (when the grid is in browse mode) and/or edit (when the grid is in edit mode) column values:

Template	Description
ColumnBase.CellDisplayTemplate / DataViewBase.CellDisplayTemplate	Defines a template that displays column values.
ColumnBase.CellEditTemplate / DataViewBase.CellEditTemplate	Defines a template that represents an editor used to edit cell values.

In the following code sample, a numeric column uses the ProgressBarEdit editors to display data. When users focus cells, the TrackBarEdit editors replace progress bars:

Xaml

<dxg:GridControl>
    <!-- ... -->
    <dxg:GridColumn FieldName="UnitsOnOrder">
        <dxg:GridColumn.CellDisplayTemplate>
            <DataTemplate>
                <dxe:ProgressBarEdit Name="PART_Editor" Minimum="0" Maximum="50" />
            </DataTemplate>
        </dxg:GridColumn.CellDisplayTemplate>
        <dxg:GridColumn.CellEditTemplate>
            <DataTemplate>
                <dxe:TrackBarEdit Name="PART_Editor" Minimum="0" Maximum="50" />
            </DataTemplate>  
        </dxg:GridColumn.CellEditTemplate>
    </dxg:GridColumn>
    <!-- ... -->   
</dxg:GridControl>

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.
• Use the editor’s EditValue property if you need to bind it in a custom way and set the editor’s Name property to 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 CellEditTemplate 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 DataViewBase.CellEditTemplateSelector property.

If both the CellDisplayTemplate and DataViewBase.CellEditTemplateSelector 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 CellEditTemplate property is used.