TdxHintedTextClickEvent Type

The procedural type for hint-marked text range click events in DevExpress controls with support for BBCode-Inspired Text Formatting Markup.

Declaration

TdxHintedTextClickEvent = procedure(Sender: TObject; AArgs: TdxHintedTextClickEventArgs) 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	TdxHintedTextClickEventArgs	Contains information about the event raised by the UI element available through the Sender parameter. For example, you can use AArgs.Button and AArgs.Shift to identify the clicked mouse button and modifier keys held while the button was clicked.

Remarks

You can handle this event to implement a custom response to a click on a text range 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.

Event Occurrence

This event occurs every time a user clicks a text range enclosed between [HINT] and [/HINT] tags within a formatted message, label, or UI element caption.

Available Event Parameters

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

Sender

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

AArgs

Contains information about the hint-marked text range click event. Use the AArgs.Button and AArgs.Shift properties to identify the clicked mouse button and modifier key state when the event occurred.

Refer to the TdxHintedTextClickEventArgs class description for detailed information on all options available within a hint-marked text click event handler.

Direct Type References

The TdxFormattedTextPropertiesBase.OnHintedTextClick event references the TdxHintedTextClickEvent procedural type.