TdxShowTextHintEvent Type

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

Declaration

TdxShowTextHintEvent = procedure(Sender: TObject; AArgs: TdxShowTextHintEventArgs) 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	TdxShowTextHintEventArgs	Contains information about the event raised by the UI element available through the Sender parameter. For example, you can use the AArgs.Hint property to change the hint message depending on certain conditions in your application.

Remarks

DevExpress controls with support for formatted messages, labels, and UI label captions display a hint for a text range enclosed between [HINT] and [\HINT] tags when a user hovers the mouse pointer over the text range.

You can handle a hint display event to modify the hint message for a hint-marked text range before the message is displayed.

Event Occurrence

This event occurs every time a hint for a hint-marked text range is about to appear.

Available Event Parameters

The following parameters are available within a hint display event handler:

Sender

Provides access to the control or UI element that raised the hinted text hint display event. The Sender parameter type depends on the class that declares the corresponding OnShowTextHint event:

AArgs

Contains information about the hinted text hint display event. Use the AArgs.Hint property to change the hint text.

Refer to the TdxShowTextHintEventArgs class description for detailed information about options available in a hinted text hint display event handler.

Direct Type References

The TdxFormattedTextPropertiesBase.OnShowTextHint event references the TdxShowTextHintEvent procedural type.