Skip to main content

TdxPDFViewerOnHyperlinkClickEvent Type

The PDF Viewer control’s hyperlink activation event type.

Declaration

TdxPDFViewerOnHyperlinkClickEvent = procedure(Sender: TdxPDFCustomViewer; const AURI: string; var AHandled: Boolean) of object;

Parameters

Name Type
Sender TdxPDFCustomViewer
AURI string
AHandled Boolean

Remarks

Use the Sender parameter to refer to the PDF Viewer control that raised the OnHyperlinkClick event. To access the control’s type-specific properties, cast the parameter to the TdxPDFViewer class.

The AURI parameter returns the universal resource identifier of the hyperlink clicked by an end-user. Use this parameter to identify which hyperlink an end-user activates and respond differently to clicking different hyperlinks. For instance, you can identify a hyperlink as external and invoke a notification or confirmation message box on clicking the hyperlink.

To disable the default hyperlink activation routines, set the AHandled parameter to True within your OnHyperlinkClick event handler.

The PDF Viewer control’s OnHyperlinkClick event references the TdxPDFViewerOnHyperlinkClickEvent type.

See Also