Skip to content

Hyperlink interface

The Hyperlink interface represents a single hyperlink on a given page.

To obtain this interface, call the Page.GetNextHyperlink method.

Hyperlink::DestBottom property

The DestBottom gets the bottom position of the hyperlink destination in pixels.

Hyperlink::DestFit property

The DestFit property stores the destination fit type. See PDF Reference for additional details.

Hyperlink::DestLeft property

The DestLeft gets the left position of the hyperlink destination in pixels.

Hyperlink::DestRight property

The DestRight gets the right position of the hyperlink destination in pixels.

Hyperlink::DestTop property

The DestTop gets the top position of the hyperlink destination in pixels.

Hyperlink::DestZoom property

The DestTop gets the top position of the hyperlink destination in pixels.

Hyperlink::Flags property

The Flags property stores the flags describing which fields are valid. This property is used in combination with the DestFit property. See PDF reference for more information.

Hyperlink::Height property

The Height property stores the height of the hyperlink element in pixels.

Hyperlink::HyperlinkType property

The HyperlinkType property stores the actions that should be performed when a user clicks on the link.

Hyperlink::PageNumber property

The PageNumber property stores the page number to navigate to if the HyperlinkType contains IGR_HYPERLINK_ACTION_GOTO.

Hyperlink::Ref property

The Ref property stores the reference within a document to navigate to when the user clicks on the link. This value is only valid if the hyperlink type contains the value IGR_HYPERLINK_ACTION_GOTO.

Hyperlink::Uri property

The Uri property stores the URI to navigate to when the user clicks on the link. This value is only valid if the hyperlink type contains the value IGR_HYPERLINK_ACTION_URI.

Hyperlink::Width property

The Width property stores the width of the hyperlink element in pixels.

Hyperlink::X property

The X property stores the horizontal position of the hyperlink element in pixels.

Hyperlink::Y property

The Y property stores the vertical position of the hyperlink element in pixels.