LookUpEdit.StyleSettings Property

Gets or sets an object that defines the appearance and behavior of the LookUpEdit.

Namespace: DevExpress.Xpf.Grid.LookUp

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

Declaration

[Browsable(true)]
public BaseEditStyleSettings StyleSettings { get; set; }
<Browsable(True)>
Public Property StyleSettings As BaseEditStyleSettings

Property Value

Type Description
BaseEditStyleSettings

A BaseEditStyleSettings descendant that defines the appearance and behavior of the LookUpEdit.

Remarks

Operation Modes

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 are represented by tokens.

SearchTokenLookUpEdit

SearchTokenLookUpEditStyleSettings

Editor's dropdown displays a grid and a search box. Allows multiple item selection.

Selected items are represented by tokens.

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

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

<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 Operation Mode

LookUpEdit mode is used by default.

Editor's dropdown displays a fully-functional grid that supports the following features.

  • single item selection;
  • data filtering;
  • data grouping;
  • data sorting.

simple LookUpEdit

To learn more, see LookUpEditStyleSettings.

SearchLookUpEdit Operation Mode

In addition to the standard features, SearchLookUpEdit displays a search box.

SearchLookUpEdit Black2010

To learn more, see SearchLookUpEditStyleSettings

MultiSelectLookUpEdit Operation Mode

In addition to the standard features, MultiSelectLookUpEdit supports multiple item selection.

MultiSelectLookUpEdit

To learn more, see MultiSelectLookUpEditStyleSettings.

TokenLookUpEdit Operation Mode

TokenLookupEdit mode is inspired by modern mail clients.

In addition to the standard features, TokenLookupEdit supports the following:

  • multiple items selection;
  • selected items are represented by tokens.

TokenLookUpEdit

To learn more, see TokenLookUpEditStyleSettings.

SearchTokenLookUpEdit Operation Mode

SearchTokenLookupEdit mode is inspired by modern mail clients.

In addition to the standard features, SearchTokenLookupEdit supports the following:

  • data search;
  • multiple items selection;
  • selected items are represented by tokens.

SearchTokenLookUpEdit

To learn more, see SearchTokenLookUpEditStyleSettings.

LookUpEdit Operation Mode Comparison

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

Grouping Filtering Sorting Single Item Selection Multiple Item Selection Search Tokens Text Editing
LookUpEdit yes yes yes yes no no no yes
SearchLookUpEdit yes yes yes yes no yes no no
MultiselectLookUpEdit yes yes yes yes yes no no no
TokenLookUpEdit yes yes yes yes yes no yes yes
SearchTokenLookUpEdit yes yes yes yes yes yes yes no

Example: How to: Create a SearchLookUpEdit and Bind it to Data

See Also