BaseListBoxControl.HighlightedItemStyle Property

Gets or sets the paint mode for the selected and hot-tracked items.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

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

VB.NET

<DXCategory("Appearance")>
<DefaultValue(HighlightStyle.Default)>
Public Overridable Property HighlightedItemStyle As HighlightStyle

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

If item hot-tracking is disabled, 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 with the BaseListBoxControl.HotTrackItems property, 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 BaseListBoxControl.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 BaseListBoxControl.HotTrackSelectMode property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the HighlightedItemStyle property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-provide-the-colorsource-property-for-coloredit-t306403/CS/T306403/CustomColorEdit/CustomPopupColorBuilder.cs#L20

ColorListBox colorBox = CreateColorListBox();
colorBox.HighlightedItemStyle = Properties.HighlightedItemStyle;
object[] colors = new object[(this.Properties as RepositoryItemCustomColorEdit).ColorSource.Count];

VB.NET

how-to-provide-the-colorsource-property-for-coloredit-t306403/VB/T306403/CustomColorEdit/CustomPopupColorBuilder.vb#L22

Dim colorBox As ColorListBox = CreateColorListBox()
colorBox.HighlightedItemStyle = Properties.HighlightedItemStyle
Dim colors(((TryCast(Me.Properties, RepositoryItemCustomColorEdit)).ColorSource.Count) - 1) As Object