RepositoryItemCheckedComboBoxEdit.HighlightedItemStyle Property

Gets or sets the paint mode for the selected and hot-tracked items in the CheckedListBoxControl embedded in the dropdown window.

Namespace: DevExpress.XtraEditors.Repository

Assembly: DevExpress.XtraEditors.v21.2.dll

Declaration

[DXCategory("Appearance")]
[DefaultValue(HighlightStyle.Default)]
public virtual HighlightStyle HighlightedItemStyle { get; set; }

Property Value

Type Default Description
HighlightStyle

Default

A HighlightStyle value that specifies the paint mode for the selected and hot-tracked items.

Available values:

Name Description
Default

The same as the Skinned option.

Standard

Selected and hot-tracked items are not skinned and painted using the default system color.

In a BaseListBoxControl control’s descendants, if item hot-tracking is enabled, selected and hot-tracked items are always in sync, and setting the BaseListBoxControl.HotTrackSelectMode property to SelectItemOnClick is not in effect.

Skinned

Selected and hot-tracked items are painted skinned if a skinning painting scheme is applied. Otherwise, items are not skinned.

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.

If item hot-tracking is disabled (default), the HighlightedItemStyle property only affects the paint mode of the selected items. The property can be set to one of the following values:

  • Default/Skinned - Enables item skinning. This mode is only in effect if the List Box control is painted using a skinning paint scheme (see BaseControl.LookAndFeel).
  • Standard - Items are not skinned.

If item hot-tracking is enabled (see the RepositoryItemCheckedComboBoxEdit.HotTrackItems setting), the HighlightedItemStyle property affects two aspects:

  • paint mode for the selected and hot-tracked items.
  • automatic selection of a hot-tracked item.

If the HighlightedItemStyle property is set to Default or Skinned, the selected and hot-tracked items are painted using dedicated skin elements from the current skin.
In this paint mode, an item can be automatically selected or not on hot-tracking, dependent on the RepositoryItemCheckedComboBoxEdit.HotTrackSelectMode property value.

If the HighlightedItemStyle property is set to Standard, the selected and hot-tracked items are not skinned and are always in sync. After an item has been hot-tracked, it’s automatically selected and painted using the default system color. For more information, see the RepositoryItemCheckedComboBoxEdit.HotTrackSelectMode property.

See Also