LookUpEditBase.ItemTemplate Property

Gets or sets a template that defines the presentation of items contained within the dropdown list. This is a dependency property.

Namespace: DevExpress.Xpf.Editors

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

Declaration

C#

[Browsable(false)]
public DataTemplate ItemTemplate { get; set; }

VB.NET

<Browsable(False)>
Public Property ItemTemplate As DataTemplate

Property Value

Type	Description
DataTemplate	A DataTemplate object that represents the template which defines the presentation of items contained within the dropdown list.

Remarks

To apply ItemTemplate to the selected item (displayed within the edit box), set the LookUpEditBase.ApplyItemTemplateToSelectedItem property to true.

Note

The ItemTemplate property cannot be used if combobox items are represented by the ComboBoxEditItem class.

Example

The following example shows how to create an image combobox via templates.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-an-image-combobox-e1970.

Window1.xaml

<Window xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        x:Class="ComboBoxEdit_CreatingImageComboBox.Window1"
        xmlns:sys="clr-namespace:System;assembly=mscorlib"
        Title="Creating an Image ComboBox"
        Height="300" Width="300">
    <Grid>
        <Grid.ColumnDefinitions>
            <ColumnDefinition />
            <ColumnDefinition Width="100" />
            <ColumnDefinition />
        </Grid.ColumnDefinitions>
        <Grid.RowDefinitions>
            <RowDefinition />
            <RowDefinition Height="22" />
            <RowDefinition />
        </Grid.RowDefinitions>
        <dxe:ComboBoxEdit ApplyItemTemplateToSelectedItem="True" IsTextEditable="False"
                          Text="(None)" Grid.Row="1" Grid.Column="1" Padding="5,2,5,2">
            <dxe:ComboBoxEdit.ItemTemplate>
                <DataTemplate>
                    <Border Background="Transparent">
                        <StackPanel Orientation="Horizontal">
                            <Rectangle Width="10" Height="10" Fill="{Binding}"
                                       RadiusX="2" RadiusY="2"
                                       Margin="6,0,6,0" />
                            <TextBlock Text="{Binding}" />
                        </StackPanel>
                    </Border>
                </DataTemplate>
            </dxe:ComboBoxEdit.ItemTemplate>
            <sys:String>Red</sys:String>
            <sys:String>Green</sys:String>
            <sys:String>Blue</sys:String>
        </dxe:ComboBoxEdit>
    </Grid>
</Window>

Application.xaml

<Application x:Class="ComboBoxEdit_CreatingImageComboBox.App" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" StartupUri="Window1.xaml">
    <Application.Resources>

    </Application.Resources>
</Application>

Application.xaml.vb

Imports System
Imports System.Collections.Generic
Imports System.Configuration
Imports System.Data
Imports System.Linq
Imports System.Windows

Namespace ComboBoxEdit_CreatingImageComboBox
    ''' <summary>
    ''' Interaction logic for App.xaml
    ''' </summary>
    Partial Public Class App
        Inherits Application

    End Class
End Namespace

Window1.xaml.vb

Imports System.Windows

Namespace ComboBoxEdit_CreatingImageComboBox
    ''' <summary>
    ''' Interaction logic for Window1.xaml
    ''' </summary>
    Partial Public Class Window1
        Inherits Window

        Public Sub New()
            InitializeComponent()
        End Sub
    End Class
End Namespace

Window1.xaml.cs

using System.Windows;

namespace ComboBoxEdit_CreatingImageComboBox {
    /// <summary>
    /// Interaction logic for Window1.xaml
    /// </summary>
    public partial class Window1 : Window {
        public Window1() {
            InitializeComponent();
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ItemTemplate 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-customize-resource-filtering-controls-for-the-scheduler-e3412/CS/MainWindow.xaml#L48

<dxsch:ResourcesComboBoxControl Grid.Row="0" SchedulerControl="{Binding ElementName=scheduler}" ShowAllResourcesItem="False" ShowNoneResourcesItem="False" ItemTemplate="{StaticResource ResourceDataTemplate}" />
<dxsch:ResourcesPopupCheckedListBoxControl Grid.Row="1" SchedulerControl="{Binding ElementName=scheduler}" ItemTemplate="{StaticResource ResourcesPopupDataTemplate}" />

Reporting_wpf-report-designer-how-to-register-a-custom-page-in-the-report-wizard-t600080/CS/CustomReportWizard/App.xaml#L30

  ItemsSource="{Binding AvailablePaperKinds}" EditValue="{Binding SelectedPaperKind, UpdateSourceTrigger=PropertyChanged}">
<dxe:ComboBoxEdit.ItemTemplate>
    <DataTemplate>

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

              Grid.Column="1" Grid.RowSpan="2">
<dxe:ComboBoxEdit.ItemTemplate>
    <DataTemplate>

dxscheduler-for-wpf-complete-implementation-of-a-custom-edit-appointment-form-e3374/CS/CustomAppointmentForm.xaml#L179

ApplyItemTemplateToSelectedItem="True"
ItemTemplate="{StaticResource RecTypeTemplate}"
ItemsSource="{Binding RecurrenceVisualController.RecurrenceElements}"

Reporting_wpf-end-user-report-designer-how-to-hide-a-property-in-the-properties-window-t285448/CS/Dictionary1.xaml#L121

    EditValue="{Binding SelectedItem, RelativeSource={RelativeSource TemplatedParent}, Mode=TwoWay, UpdateSourceTrigger=PropertyChanged}">
<dxe:ComboBoxEdit.ItemTemplate>
    <DataTemplate>