RepositoryItemCheckedComboBoxEdit.HotTrackSelectMode Property
Gets or sets how items in the embedded CheckedListBoxControl are selected when item hot-tracking is enabled.
Namespace: DevExpress.XtraEditors.Repository
Assembly: DevExpress.XtraEditors.v24.1.dll
NuGet Package: DevExpress.Win.Navigation
Declaration
[DefaultValue(HotTrackSelectMode.SelectItemOnHotTrack)]
[DXCategory("Behavior")]
public virtual HotTrackSelectMode HotTrackSelectMode { get; set; }Property Value
| Type | Default | Description |
|---|---|---|
| HotTrackSelectMode | SelectItemOnHotTrack | A HotTrackSelectMode value that specifies how items are selected. |
Available values:
| Name | Description |
|---|---|
| SelectItemOnHotTrack | If item hot-tracking is enabled, an item is selected when hovering over it with the mouse. |
| SelectItemOnClick | If item hot-tracking is enabled, an item is selected when clicked. This option is not in effect if the BaseListBoxControl.HighlightedItemStyle property is set to HighlightStyle.Standard. |
| SelectItemOnHotTrackEx | The same as the HotTrackSelectMode.SelectItemOnHotTrack option plus the following. If item skinning is enabled via the BaseListBoxControl.HighlightedItemStyle option, the BaseListBoxControl.SelectedIndexChanged event is raised each time an item is hot-tracked. In HotTrackSelectMode.SelectItemOnHotTrack mode, the BaseListBoxControl.SelectedIndexChanged event is raised only when clicking the item. |
Remarks
Note
The CheckedListBoxControl embedded in the dropdown window is used to toggle item check states. The control also supports the item selection feature, which allows for the visual highlighting (selection) of one or more items. When one or more items are selected, you can toggle the check states of all selected items at once by pressing the SPACE key or clicking a check box of any selected item.
Dedicated options provided by the RepositoryItemCheckedComboBoxEdit class allow you to enable the item hot-tracking feature and then activate/deactivate automatic item selection on hot-tracking.
To learn more about the difference between the item states, see the Checked States vs. Selection vs. Hot-Tracking section in the CheckedListBoxControl topic.
To enable item hot-tracking, set the RepositoryItemCheckedComboBoxEdit.HotTrackItems property to true, and ensure that multiple item selection is disabled (see RepositoryItemCheckedComboBoxEdit.AllowMultiSelect).
The HotTrackSelectMode and RepositoryItemCheckedComboBoxEdit.HighlightedItemStyle properties specify the way hot-tracked items are selected. Choose from the following two modes:
Immediately select an item once it is hot-tracked (the default mode)
This mode is in effect in the following cases:
- The RepositoryItemCheckedComboBoxEdit.HighlightedItemStyle property is set to Default or Skinned, and the HotTrackSelectMode property is set to SelectItemOnHotTrack or SelectItemOnHotTrackEx.
- The RepositoryItemCheckedComboBoxEdit.HighlightedItemStyle property is set to Standard.
Select a hot-tracked item after a click
To enable this mode, set the properties as follows:
- The RepositoryItemCheckedComboBoxEdit.HighlightedItemStyle property to Default or Skinned, and the HotTrackSelectMode property to SelectItemOnClick.