BaseEdit.DisplayTemplate Property

Gets or sets a template that defines the editor’s presentation when its value is not edited (display mode). This is a dependency property.

Namespace: DevExpress.Xpf.Editors

Assembly: DevExpress.Xpf.Core.v19.2.dll

Declaration

C#

[Browsable(false)]
public ControlTemplate DisplayTemplate { get; set; }

VB.NET

<Browsable(False)>
Public Property DisplayTemplate As ControlTemplate

Property Value

Type	Description
ControlTemplate	A ControlTemplate object representing the editor’s template.

Remarks

Standalone Editor

A standalone editor is always in edit mode. Setting the DisplayTemplate property has no effect. To customize the editor’s presentation, use the BaseEdit.EditTemplate property.

In-Place Editor

If the editor is used inplace within a container control (e.g. the grid), its mode depends on whether its owning cell is edited. If a cell is edited, its editor is in edit inplace mode. Otherwise, it is in display mode.

To customize the editor’s presentation, create the corresponding templates (display and/or edit template) and assign them to the DisplayTemplate and BaseEdit.EditTemplate properties.

To learn more on inplace editors, see Inplace Editors.

A template that represents the editor’s border can be specified using the BaseEdit.BorderTemplate property.

Related GitHub Examples

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

how-to-select-different-templates-when-printcellstyle-is-used-t156632/VB/PrintCellStyleSelector/Dictionary.xaml#L42

<Setter Property="dxp:ExportSettings.TargetType" Value="Panel"/>
<Setter Property="DisplayTemplate">
    <Setter.Value>

how-to-export-a-custom-control-from-the-gridcontrol-cell-t190899/VB/dxSampleGrid/MainWindow.xaml#L76

<Setter Property="dxp:ExportSettings.PropertiesHintMask" Value="TargetType" />
<Setter Property="DisplayTemplate">
    <Setter.Value>

wpf-treelist-use-hierarchical-data-templates-to-build-a-tree/VB/MainWindow.xaml#L66

ItemsSource="{Binding DataSource, Source={StaticResource states}}"
DisplayTemplate="{StaticResource ComboBoxStateItemTemplate}"
EditNonEditableTemplate="{StaticResource ComboBoxStateItemTemplate}"