Skip to main content

TcxLookupComboBox Class

Represents a lookup combo box control.

Declaration

TcxLookupComboBox = class(
    TcxCustomLookupComboBox
)

Remarks

The TcxLookupComboBox object represents an editor displaying values from the data source specified via the Properties.ListSource property. The ListSource field values are displayed within the editor dropdown window, containing a TcxLookupGrid control. The following image demonstrates the lookup combo box displaying two columns within the dropdown:

Fields, whose values are displayed within the dropdown window, are identified via the Properties.ListFieldNames property value. Each field has a corresponding column within the editor’s dropdown window and in the Properties.ListColumns collection. A data source field, whose values are displayed and edited within the edit region, is identified by the Properties.ListFieldIndex property, which represents the index of a column within the Properties.ListColumns collection.

The editor’s edit value (the EditValue property) matches the ListSource key field value (identified via the Properties.KeyFieldNames property) corresponding to the record containing the currently displayed value.

You can specify the EditValue via code. If there is no records in ListSource whose key field values match the edit value, the editor displays nothing.

The TcxLookupComboBox supports an incremental search feature against the field whose value is displayed in the edit box (it is addressed by the Properties.ListFieldIndex property). When a user types within the edit region, the editor activates the dropdown window and locates the first record whose key field value starts with the characters typed.

If the Properties.IncrementalFiltering property value is True, the editor filters the dropdown list values according to the first characters typed. The following image demonstrates the lookup combo box during typing with the Properties.IncrementalFiltering property set to True:

See Also