TdxHintedTextMouseHoverEvent Type

The procedural type for hint-marked text mouse hover events in DevExpress controls with support for BBCode-inspired text formatting markup.

Declaration

TdxHintedTextMouseHoverEvent = procedure(Sender: TObject; AArgs: TdxHintedTextEventArgs) of object;

Parameters

Name	Type	Description
Sender	TObject	Provides access to the control or UI element that raised the event. Cast this parameter value to the corresponding terminal control or UI element class to access its public API members. Refer to the following section for detailed information on Sender types in different DevExpress products: Available Event Parameters. Tip Call the Sender.ClassType function or use other RTTI functionality to identify the actual control or UI element type.
AArgs	TdxHintedTextEventArgs	Contains information about the event raised by the UI element available through the Sender parameter. For example, you can use AArgs.HintIndex and AArgs.Hint properties to identify the target text range position and the corresponding hint message.

Remarks

You can handle this event to track mouse pointer movements between text ranges enclosed between [HINT] and [\HINT] tags within a formatted message, label, or UI element caption in a DevExpress control with support for BBCode-inspired text formatting markup.

Available Event Parameters

The following parameters are available within a hint-marked text mouse hover event handler:

Sender

Provides access to the control or UI element that raised the hint-marked text hover event. The Sender parameter type depends on the class that declares the corresponding OnHintedTextMouseEnter event:

AArgs

Contains information about the hint-marked text mouse hover event that occurred and allows you to identify the target text range in a formatted message, label, or UI element caption. For example, you can use AArgs.HintIndex and AArgs.Hint properties to identify the hovered text range’s position and its defined hint text.

Refer to the TdxHintedTextEventArgs class description for detailed information on all options accessible within a hint-marked text mouse hover event handler.

Direct Type References

The following events reference the TdxHintedTextMouseHoverEvent procedural type:

TdxFormattedTextPropertiesBase.OnHintedTextMouseEnter

Allows you to execute custom code when the mouse pointer moves over a hint-marked text range.

TdxFormattedTextPropertiesBase.OnHintedTextMouseLeave

Allows you to execute custom code when the mouse pointer leaves a hint-marked text range.