LookUpEdit

• Aug 07, 2024
• 3 minutes to read

You can fine-tune a lookup editor by using the BaseEdit.StyleSettings property. This property allows you to alter the appearance and behavior of a lookup editor by adding extra features like searching and multiple item selection. To apply specific settings, assign the lookup’s BaseEdit.StyleSettings property to one of the objects listed in the table below.

LookUpEdit mode	Corresponding settings object	Description
LookUpEdit	LookUpEditStyleSettings	Editor’s dropdown displays a grid. This is a default setting.
SearchLookUpEdit	SearchLookUpEditStyleSettings	Editor’s dropdown displays a grid and a search box.
MultiSelectLookUpEdit	MultiSelectLookUpEditStyleSettings	Editor’s dropdown displays a grid that allows you to select multiple items.
TokenLookUpEdit	TokenLookUpEditStyleSettings	Editor’s dropdown displays a grid that allows you to select multiple items. Selected items appear as tokens.
SearchTokenLookUpEdit	SearchTokenLookUpEditStyleSettings	Editor’s dropdown displays a grid and a search box. Allows multiple item selection. Selected items appear as tokens.

Each of the settings objects has a number of properties that you can use to enable or disable the following grid features.

• Filtering (using the LookUpEditStyleSettings.AllowColumnFiltering property)
• Grouping (using the LookUpEditStyleSettings.AllowGrouping property)
• Sorting (using the LookUpEditStyleSettings.AllowSorting property)

The code example below shows a lookup editor in SearchLookUp mode with the grouping feature disabled.

XAML

<dxg:LookUpEdit>
    <dxg:LookUpEdit.StyleSettings>
        <dxg:SearchLookUpEditStyleSettings AllowGrouping="False"/>
    </dxg:LookUpEdit.StyleSettings>
</dxg:LookUpEdit>

The following sections describe different settings provided by the LookUpEdit control in detail.

LookUpEdit

LookUpEdit mode is used by default.

The editor’s dropdown displays a fully-functional grid that supports the following features:

• Single item selection
• Data filtering
• Data grouping
• Data sorting

To learn more, see LookUpEditStyleSettings.

SearchLookUpEdit

In addition to LookUpEdit features, SearchLookUpEdit displays the embedded GridControl’s search panel. This panel allows users to find information within the data grid.

To learn more, see SearchLookUpEditStyleSettings.

MultiSelectLookUpEdit

In addition to LookUpEdit features, MultiSelectLookUpEdit supports multiple item selection.

To learn more, see MultiSelectLookUpEditStyleSettings.

TokenLookUpEdit

TokenLookupEdit mode is inspired by modern mail clients.

In addition to LookUpEdit features, TokenLookupEdit supports the following:

• Multiple item selection
• Selected items appear as tokens

To learn more, see TokenLookUpEditStyleSettings.

SearchTokenLookUpEdit

SearchTokenLookupEdit mode is inspired by modern mail clients.

In addition to LookUpEdit features, SearchTokenLookupEdit supports the following:

• Data search
• Multiple item selection
• Selected items appear as tokens

To learn more, see SearchTokenLookUpEditStyleSettings.

LookUpEdit Modes Comparison

The table below compares the features of different LookUpEdit operation modes.

	Grouping	Filtering	Sorting	Single Item Selection	Multiple Item Selection[1]	Search	Tokens	Text Editing
LookUpEdit
SearchLookUpEdit
MultiselectLookUpEdit
TokenLookUpEdit
SearchTokenLookUpEdit

Footnotes

1. Refer to the following help topic for more information: Multiple Selection in ComboBoxEdit, LookUpEdit, and ListBoxEdit.