Skip to main content

TcxCustomDBLookupEditProperties Class

Represents a set of properties controlling the behavior of lookup editors.

Declaration

TcxCustomDBLookupEditProperties = class(
    TcxCustomLookupEditProperties
)

Remarks

The TcxCustomDBLookupEditProperties class provides properties common to both LookupComboBox and ExtLookupComboBox controls. These controls extend the functionality of the TcxCustomDBLookupEditProperties class by declaring additional properties.

A lookup editor displays a set of records obtained from a data source in its dropdown window. For a LookupComboBox editor, the data source is specified by its Properties.ListSource attribute. An ExtLookupComboBox displays a data-aware (banded) table view in its dropdown, and the data source is identified by this view.

The TcxCustomDBLookupEditProperties allows you to specify a list of fields displayed in the dropdown window via the ListFieldNames property. For a LookupComboBox editor you can do the same via its Properties.ListColumns property. The ExtLookupComboBox control displays a data-aware (banded) table view in the dropdown. So you are able to specify the visibility and group position of each column via the view’s properties.

When a user selects a specific record from the dropdown window, this changes the edit value of the lookup editor and display text. The display text is defined by the selected record’s field whose index is set via the ListFieldIndex property. The editor’s edit value is obtained from the record’s field(s) identified by the KeyFieldNames property. If you specify several fields via the KeyFieldNames property, the edit value will hold an array of variants. The edit value is accessible via the editor’s EditValue property. Changing it results in selecting a record whose key field values (KeyFieldNames) match the edit value(s). The CaseSensitiveSearch property allows you to specify whether the matching is case sensitive.

See Also