LookUpEdit Class

Represents a lookup editor.

Namespace: DevExpress.Xpf.Grid.LookUp

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

Declaration

C#

public class LookUpEdit :
    LookUpEditBase

VB.NET

Public Class LookUpEdit
    Inherits LookUpEditBase

Remarks

This a multi-column combo box that provides the lookup functionality using an embedded DXGrid control for WPF.

Its features include:

• Display and edit values can be taken from separate data fields specified by the LookUpEditBase.DisplayMember and LookUpEditBase.ValueMember properties, respectively.
• Multiple sort modes including auto-completion and incremental filtering (LookUpEditBase.AutoComplete, LookUpEditBase.IncrementalFiltering).
• Custom processing for entering not-in-list values. The LookUpEditBase.ProcessNewValue event can be handled to insert new records into the underlying data source (LookUpEditBase.ItemsSource).
• Embedded DXGrid Control.
• A nearly unlimited set of options to customize the dropdown list by exploiting the features provided by the DXGrid Control. These include customizable columns collection, data summaries, sorting, grouping and filtering dropdown list data by column values, and much more.

Lookup Editor can be used both as a standalone editor as well as an in-place editor within the DXGrid Control.

Example

This example shows how to customize the DXGrid Control displayed within the Lookup editor's popup window.Note: the embedded DXGrid name must be set to PART_GridControl.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/lookupedit-how-to-customize-the-embedded-grid-control-e2648.

MainWindow.xaml

<Window x:Class="HowToCreateLookUpEdit.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525"
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core">
    <Grid>
        <dxg:LookUpEdit Name="lookUpEdit1"
                        DisplayMember="ProductName"
                        ValueMember="ID"
                        AutoPopulateColumns="False"
                        AutoComplete="True"
                        IncrementalFiltering="True"
                        ImmediatePopup="True"
                        IsPopupAutoWidth="False"
                        HorizontalAlignment="Center"
                        VerticalAlignment="Top"
                        Width="200" Margin="10">
            <dxg:LookUpEdit.PopupContentTemplate>
                <ControlTemplate>
                    <dxg:GridControl Name="PART_GridControl">
                        <dxg:GridControl.Columns>
                            <dxg:GridColumn FieldName="ProductName" />
                            <dxg:GridColumn FieldName="UnitPrice" />
                            <dxg:GridColumn FieldName="Quantity" />
                        </dxg:GridControl.Columns>
                        <dxg:GridControl.View>
                            <dxg:TableView AutoWidth="True" />
                        </dxg:GridControl.View>
                    </dxg:GridControl>
                </ControlTemplate>
            </dxg:LookUpEdit.PopupContentTemplate>
        </dxg:LookUpEdit>
    </Grid>
</Window>

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System.Windows

Namespace HowToCreateLookUpEdit
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            lookUpEdit1.ItemsSource = New ProductList()
        End Sub
    End Class
End Namespace

MainWindow.xaml.cs

using System.Windows;

namespace HowToCreateLookUpEdit {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            lookUpEdit1.ItemsSource = new ProductList();
        }
    }
}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the LookUpEdit class.

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-change-the-appearance-of-editors-when-validation-error-occurs-e3097/CS/WPFCustomValidationErrorPresenter/MainWindow.xaml#L43

    <TextBlock Text="LookUpEdit:" Margin="5,10,0,0" />
    <dxg:LookUpEdit Name="lookUpEdit1" ValidateOnTextInput="True" Validate="textEdit_Validate" InvalidValueBehavior="AllowLeaveEditor" HorizontalAlignment="Left" Width="200" />
</StackPanel>

how-to-filter-a-lookupedit-in-one-column-based-on-the-value-of-another-column-e3826/VB/MainWindow.xaml#L23

<DataTemplate>
    <dxg:LookUpEdit Name="PART_Editor" ItemsSource="{Binding View.DataContext.Cities}" ValueMember="CityId" DisplayMember="CityName" />
</DataTemplate>

wpf-lookupedit-display-treelist-as-popup-content/CS/CustomTreeViewComboBox/MainWindow.xaml#L15

<dxg:LookUpEdit Name="lookUpEdit" VerticalAlignment="Top" Width="350" Margin="50,37,67,0" DisplayMember="Name">
    <dxg:LookUpEdit.PopupContentTemplate>

lookupedit-processing-new-values-e2646/CS/HowToCreateLookUpEdit/MainWindow.xaml#L15

<Grid>
    <dxg:LookUpEdit Name="lookUpEdit1" ItemsSource="{Binding Path=Products}"
                    HorizontalAlignment="Center" VerticalAlignment="Center"

LookUpEdit-How-to-support-multiple-row-selection-with-CheckBoxes/CS/LookUpEditWithCheckboxes/MainWindow.xaml#L11

<Grid>
    <dxg:LookUpEdit ItemsSource="{Binding Items}"
                    VerticalAlignment="Center"

Inheritance

Show 14 items

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

BaseEdit

TextEditBase

TextEdit

ButtonEdit

PopupBaseEdit

LookUpEditBase

LookUpEdit

Extension Methods

GetErrorOperationCommands(Position)

GetErrorOperationCommands(Int32)

GetErrorOperationCommands(Point)