Back to Devexpress

TcxCustomImageComboBox Class

vcl-cximagecombobox-fd86a3f9.md

latest7.5 KB
Original Source

TcxCustomImageComboBox Class

The base class for image combo box editors.

Declaration

delphi
TcxCustomImageComboBox = class(
    TcxCustomComboBox
)

Remarks

An image combo box can display images in addition to the text description in every item available for selection.

End-User Input Options

↑ and ↓ arrow keys allow users to switch between combo box items, even when the drop-down menu is closed. Ctrl + Page Up and Ctrl + Page Down keystrokes select first and last items, respectively.

Drop-Down Menu Interaction

Users can do the following to open or close the drop-down combo box menu:

  • Click the drop-down button.
  • Focus the image combo box and press the Alt + ↑ or Alt + ↓ key combination.
  • Focus the image combo box and press the F4 key.

Note

You can open the drop-down menu only if it contains at least one value.

Main API Members

The list below outlines key members of the TcxCustomImageComboBox class. These members allow you to configure image combo boxes and manage combo box items.

Appearance and Behavior Settings

BeepOnEnterSpecifies if the combo box plays the default system sound when a user confirms input.Style | StyleDisabled | StyleFocused | StyleHot | StyleReadOnly

Allow you to define individual appearance settings for different editor states.

Tip

To apply the same style settings to multiple editors, use a TcxEditStyleController component. If you need to apply the same style settings to all editors in your application, you can use a TcxDefaultEditStyleController component.

StylesProvides access to individual styles applied to the combo box in different states.

Content-Related APIs

Clear | EditingValue | EditValue | EditingText | EditText | ResetEditValueManage the edit value.CopyToClipboard | CutToClipboard | PasteFromClipboardAllow you to perform clipboard operations.CanDropDown | DroppedDown | CloseUpManage the drop-down menu.ItemIndexSpecifies the active image combo box item.OnEditingAllows you to prevent users from activating the image combo box.PopupWindowAllows you to access and customize the drop-down menu.ResetEditValueRestores the previous edit value before the pending change is applied.SelectAllSelects editor content.SelStart | SelLength | SelText | SetSelection | SelectAll | ClearSelectionManage content selection.TextHintSpecifies a text hint for the image combo box when it has no assigned edit value.UndoDiscards the last content change when the image combo box has focus.ValidateEditValidates the display value.

Image Combo Box Settings and Repository Items

ActivePropertiesProvides access to the current image combo box settings regardless of their source. This property set does not allow you to customize image combo box settings.GetPropertiesClassReturns the actual editor settings type.PropertiesAllows you to customize image combo box settings directly if the image combo box does not have an assigned repository item.RepositoryItemSpecifies a repository item as an external source of image combo box settings. A repository item has priority over other image combo box settings.

General-Purpose API Members

EnabledSpecifies if the image combo box is enabled.CanModifyIdentifies if the image combo box is in read-only mode.IsEditValidating | IsHiding | IsPostingAllow you to identify the current operation in the image combo box.Width | HeightAllow you to explicitly define image combo box dimensions.

Terminal TcxCustomImageComboBox Class Descendants

Do not use the TcxCustomImageComboBox class directly. Use the following descendants instead:

TcxImageComboBoxAn unbound combo box with support for images.TcxDBImageComboBoxA data-aware image combo box.

Inheritance

Show 16 items

TObject TPersistent TComponent TControl TWinControl TCustomControl TcxCustomControl TcxControl TcxContainer TcxCustomEditContainer TcxCustomEdit TcxCustomTextEdit TcxCustomMaskEdit TcxCustomDropDownEdit TcxCustomComboBox TcxCustomImageComboBox

See Also

TcxCustomImageComboBox Members

cxImageComboBox Unit