Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Collapse]Controls and Libraries
  [Expand]Forms and User Controls
  [Expand]Messages, Notifications and Dialogs
  [Collapse]Editors and Simple Controls
   [Expand]Simple Editors
   [Collapse]Lookup Editors
     Lookup Editors and Main Settings
     Standard Binding (to Simple Data Types)
     Advanced Binding (to Business Objects)
     Using a Dictionary Lookup Data Source
     Combobox Mode - Allow Entering New Values
     Cascading Lookups
   [Expand]Token Edit Control
   [Expand]Breadcrumb Edit Control
   [Expand]Range Control
   [Expand]Image Slider
    Camera Control
  [Expand]Ribbon, Bars and Menu
  [Expand]Application UI Manager
  [Expand]Docking Library
  [Expand]Data Grid
  [Expand]Vertical Grid
  [Expand]Pivot Grid
  [Expand]Tree List
  [Expand]Chart Control
  [Expand]Diagrams
  [Expand]Gauges
  [Expand]Map Control
  [Expand]Scheduler
  [Expand]Spreadsheet
  [Expand]Rich Text Editor
  [Expand]Spell Checker
  [Expand]Form Layout Managers
  [Expand]Navigation Controls
  [Expand]Printing-Exporting
  [Expand]PDF Viewer
   Reporting
  [Expand]Snap
  [Expand]TreeMap Control
 [Expand]Common Features
  Get More Help
 [Expand]API Reference
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Lookup Editors and Main Settings

The following lookup editors are provided by the DevExpress Windows Forms library. All of them have one descendant (LookUpEditBase), which means that they have several features in common.

Expanded LookUpEdit Control

LookUpEdit - The editor that provides lookup functionality using a lightweight dropdown grid.

Expanded GridLookUpEdit Control

GridLookUpEdit - The editor that provides lookup functionality using a dropdown feature-rich data grid (GridControl).

The use of the GridControl for the presentation of the lookup data source adds rich dropdown customization features and end-user capabilities, including, but not limited to the following:

  • presenting lookup records in a tabular, card or tile format.;
  • built-in filtration,
  • summaries;
  • conditional style formats,
  • rich cell value formatting,
  • embedding any editor from the DevExpress library into grid cells (and thus display images, check boxes, etc.)

Expanded SearchLookUpEdit

SearchLookUpEdit - The editor that provides lookup functionality using a dropdown feature-rich data grid (GridControl), and contains the built-in Find Panel, allowing end-users to quickly filter and locate dropdown rows.

Expanded TreeListLookUpEdit Control

TreeListLookUpEdit - The editor that provides lookup functionality using a dropdown TreeList control.

Expanded Main Settings

The following table shows the main properties used to set up lookup editors.

Common Properties

Property Description
BaseEdit.EditValue Gets or sets the editor's value.
Use this property in standalone mode to specify the lookup editor's value. This property is bindable.
RepositoryItemLookUpEditBase.DataSource Gets or sets the source of data displayed in the dropdown window.
RepositoryItemLookUpEditBase.ValueMember Gets or sets the field name whose values identify dropdown rows.

Use this property in standard lookup binding mode.

RepositoryItemLookUpEditBase.DisplayMember Gets or sets the field whose values are displayed in the edit box.
RepositoryItemLookUpEditBase.KeyMember Gets or sets a string that specifies a key field (or multiple key fields) used for business object identification (when a lookup editor is bound to a business object).
RepositoryItemLookUpEditBase.TextEditStyle Gets or sets the style in which text is displayed and edited in the editor.

This property allows you to enable the text editing feature in the lookup editor's edit box, which is disabled by default.

RepositoryItemLookUpEditBase.BestFitMode Gets or sets the "best-fit" mode for columns in the dropdown window.
RepositoryItem.NullText Gets or sets the string displayed in the edit box when the editor's BaseEdit.EditValue is null.
RepositoryItemLookUpEditBase.ProcessNewValue Occurs when a new value entered into the edit box is validated.
RepositoryItemLookUpEdit.Columns Provides access to the collection of columns displayed in the dropdown window.
RepositoryItemLookUpEdit.PopulateColumns Creates columns for all fields available in the lookup data source (RepositoryItemLookUpEditBase.DataSource).
RepositoryItemLookUpEdit.GetNotInListValue Occurs on retrieving values for fields not found in the RepositoryItemLookUpEditBase.DataSource.
RepositoryItemLookUpEdit.PopupWidth Gets or sets the width of the dropdown window (in pixels).
RepositoryItemLookUpEdit.DropDownRows Gets or sets the number of rows simultaneously displayed in the dropdown window.
LookUpEditBase.CascadingOwner Gets or sets the lookup editor whose value determines the filter criteria applied to the popup data source of the current lookup editor.
RepositoryItemLookUpEditBase.CascadingMember Gets or sets the name(s) of the foreign key field(s) by which the popup data source of the current lookup editor is filtered.

LookUpEdit Specific Properties

Property Description
RepositoryItemLookUpEdit.Columns Provides access to the collection of columns displayed in the dropdown window.
RepositoryItemLookUpEdit.PopulateColumns Creates columns for all fields available in the lookup data source (RepositoryItemLookUpEditBase.DataSource).
RepositoryItemLookUpEdit.GetNotInListValue Occurs on retrieving values for fields not found in the RepositoryItemLookUpEditBase.DataSource.
RepositoryItemLookUpEdit.PopupWidth Gets or sets the width of the dropdown window (in pixels).
RepositoryItemLookUpEdit.DropDownRows Gets or sets the number of rows simultaneously displayed in the dropdown window.
RepositoryItemLookUpEdit.AcceptEditorTextAsNewValue Gets or sets whether a custom value (a value that is not present in the lookup data source) that is entered in the edit box is accepted by the editor (when the value is validated and editor loses focus). This property supports Combobox mode for the lookup editor.

GridLookUpEdit Specific Properties

Property Description
RepositoryItemGridLookUpEditBase.ViewType Gets or sets the type of View used to represent data in the dropdown.
RepositoryItemGridLookUpEditBase.View Gets or sets the View used to represent data in the dropdown.
RepositoryItemGridLookUpEditBase.PopupFilterMode Gets or sets how records in the dropdown window are filtered when typing text within the edit box.
RepositoryItemGridLookUpEdit.AcceptEditorTextAsNewValue Gets or sets whether a custom value (a value that is not present in the lookup data source) that is entered in the edit box is accepted by the editor (when the value is validated and editor loses focus). This property supports Combobox mode for the lookup editor.

SearchLookUpEdit Specific Properties

Property Description
RepositoryItemGridLookUpEditBase.ViewType Gets or sets the type of View used to represent data in the dropdown.
RepositoryItemGridLookUpEditBase.View Gets or sets the View used to represent data in the dropdown.
RepositoryItemGridLookUpEditBase.PopupFilterMode Gets or sets how records in the dropdown window are filtered when typing text within the edit box.
RepositoryItemSearchLookUpEdit.PopupFindMode Gets or sets whether data searching starts automatically, or should be started manually.
RepositoryItemSearchLookUpEdit.ShowAddNewButton Gets or sets whether the "Add New" button is displayed within the editor's dropdown.
RepositoryItemSearchLookUpEdit.ShowClearButton Gets or sets whether the "Clear" button is displayed within the editor's dropdown.

TreeListLookUpEdit Specific Properties

Property Description
RepositoryItemTreeListLookUpEdit.TreeList Gets or sets a TreeList associated with the current TreeListLookUpEdit control.
RepositoryItemTreeListLookUpEdit.AutoExpandAllNodes Gets or sets whether all nodes are automatically expanded when the Tree List is being loaded. This is a dependency property.
RepositoryItemTreeListLookUpEdit.AutoComplete Gets or sets whether the automatic completion feature is enabled.
RepositoryItemTreeListLookUpEdit.PopupFilterMode Gets or sets how records in the dropdown window are filtered when typing text within the edit box.

How would you rate this topic?​​​​​​​