Skip to main content
All docs
V23.2

TcxCustomEditButton.HotTrackMode Property

Specifies the active hot-track mode.

Declaration

property HotTrackMode: TcxEditButtonHotTrackMode read; write; default TcxEditButtonHotTrackMode.Default;

Property Value

Type Default Description
TcxEditButtonHotTrackMode Default

The active hot-track mode.

Remarks

A hot-track effect helps users track the current mouse pointer position and differentiate uniform UI elements. An editor button can display a hot-track effect when a user hovers the mouse pointer over the button if the Transparent property is set to False.

VCL Editors Library: A Hot-Track Effect Example

You can use the HotTrackMode property to change the editor button’s hot-track behavior.

Property Value Examples

The following table demonstrates the difference between all hot-track modes under the same conditions:

Value Description Example[1]
TcxEditButtonHotTrackMode.Default An editor button displays a hot-track effect when a user hovers the mouse pointer directly over the button. VCL Editors Library: The Default Hot-Track Mode
TcxEditButtonHotTrackMode.Editor An editor button displays a hot-track effect when the mouse pointer is within the editor client area. VCL Editors Library: The Editor Hot-Track Mode
TcxEditButtonHotTrackMode.None An editor button never displays a hot-track effect in this mode. VCL Editors Library: The Hot-Track Effect is Disabled

Hot-Track Effect Appearance

The hot-track effect color depends on the parent editor’s look & feel settings. In addition, you can handle the parent editor’s Properties.OnButtonGlyphDrawParameters event to change the button’s glyph appearance in the hot-tracked state.

Default Value

The HotTrackMode property’s default value is TcxEditButtonHotTrackMode.Default.

Footnotes
  1. These examples demonstrate all possible HotTrackMode property values for the same button editor with one embedded button under the following conditions:

See Also