TdxShowHyperlinkHintEvent Type

The procedural type for hyperlink hint display events in DevExpress controls and their UI elements.

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 hyperlink hint display event. Cast this parameter value to the corresponding terminal control or UI element class to access all public API members. Refer to the following section for detailed information on Sender types in different DevExpress products: Accessible Event Parameters. Tip You can call the Sender.ClassType function or use any other RTTI functionality to identify the actual control or UI element type.
AArgs	TdxShowHyperlinkHintEventArgs	Provides access to information on the hyperlink hint display event that occurred in the UI element accessible 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 change the hyperlink hint message.

Event Occurrence

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

Accessible Event Parameters

The following parameters are accessible 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:

Formatted Label Editors

The actual Sender type is TdxFormattedLabel or TdxDBFormattedLabel.

Layout Control

Sender is a terminal TdxCustomLayoutItem class descendant instance (at the layout item level) or a TdxLayoutControl instance (at the layout control level).

AArgs

Provides access to information related to the occurred hyperlink hint display event. You can use the AArgs.Hint property to change hint text.

Refer to the TdxShowHyperlinkHintEventArgs class description for detailed information on all options accessible within a hyperlink hint display event.

Direct TdxShowHyperlinkHintEvent Type References

The following events reference the TdxShowHyperlinkHintEvent procedural type:

TdxCustomFormattedLabelProperties.OnShowHyperlinkHint

Allows you to change a hyperlink hint before it appears.

TdxCustomLayoutItem.OnShowHyperlinkHint

Allows you to change a hyperlink hint before it appears.

TdxCustomLayoutControl.OnShowHyperlinkHint

Allows you to change a hyperlink hint before it appears.