TdxShowHyperlinkHintEvent Type

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

Declaration

TdxShowHyperlinkHintEvent = procedure(Sender: TObject; AArgs: TdxShowHyperlinkHintEventArgs) 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	TdxShowHyperlinkHintEventArgs	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 hyperlink hint message depending on certain conditions in your application.

Remarks

DevExpress controls with support for formatted messages, labels, and UI label captions can display the target URI in a hint when a user hovers the mouse pointer over a hyperlink.

You can handle a hyperlink hint display event to modify the hyperlink hint message before it is displayed.

Event Occurrence

This event occurs every time a hyperlink hint is about to appear.

Available Event Parameters

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

Sender

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

AArgs

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

Refer to the TdxShowHyperlinkHintEventArgs class description for detailed information about options available in a hyperlink hint display event handler.

Direct Type References

The TdxFormattedTextPropertiesBase.OnShowHyperlinkHint event references the TdxShowHyperlinkHintEvent procedural type.