Back to Devexpress

TcxCheckComboBox Class

vcl-cxcheckcombobox.md

latest6.9 KB
Original Source

TcxCheckComboBox Class

An unbound combo box editor that can display items with check boxes.

Declaration

delphi
TcxCheckComboBox = class(
    TcxCustomCheckComboBox
)

Remarks

The TcxCheckComboBox class implements an unbound check combo box editor that consists of an edit box and a check list displayed in a drop-down window. Users can click check boxes in the list to select any number of items. All checked items are displayed in the edit box.

To manage check combo box items, use the Properties.Items property.

Tip

You can use a TcxCheckComboBox class instance as a standalone or in-place check combo box editor.

Main API Members

The list below outlines key members of the TcxCheckComboBox class that allow you to configure check combo box editors.

Appearance and Behavior Settings

BeepOnEnterSpecifies if the check 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 check combo box in different states.

Content-Related APIs

ClearUnchecks all items.CopyToClipboard | CutToClipboard | PasteFromClipboardAllow you to perform clipboard operations.CanDropDown | DroppedDown | CloseUpManage the drop-down menu.EditValueSpecifies all item check states as one value.ItemIndexSpecifies the active check combo box item.OnEditingAllows you to prevent users from activating the check combo box.PopupWindowAllows you to access and customize the drop-down menu.ResetEditValueRestores the previous edit value before the pending change is applied.StatesSpecifies check states for individual items.TextHintSpecifies a text hint for the check combo box when it has no assigned edit value.

Check Combo Box Settings and Repository Items

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

General-Purpose API Members

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

Check States and Edit Values

Call CalculateCheckStatesValue and CalculateCheckStates global functions to convert a check combo box editor’s edit value into an array of item check states and vice versa.

Repository Item Class

You can create a TcxEditRepositoryCheckComboBox component in an edit repository to store check combo box settings and share them between multiple check combo boxes.

Inheritance

Show 17 items

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

See Also

TcxDBCheckComboBox Class

TcxCheckComboBox Members

cxCheckComboBox Unit