Hyperlinks Property

Summary

Gets a list of the hyperlinks found in this page.

Syntax

C++

Java

public IList<PDFHyperlink> Hyperlinks {get;}

Public ReadOnly Property Hyperlinks As IList(Of PDFHyperlink)

public List<PDFHyperlink> getHyperlinks()

public: 
property IList<PDFHyperlink>^ Hyperlinks { 
   IList<PDFHyperlink>^ get(); 
}

Property Value

An IList of PDFHyperlink items that contain the hyperlinks found in the page. The default value is null.

Remarks

By default, the Annotations, Objects, FormFields, Signatures and Hyperlinks lists are not populated when a new PDFDocument is created and the values of these properties are null. You must call the PDFDocument.ParsePages method to parse the items are you interested in (depending on the PDFParsePagesOptions passed as the options parameter to the method). This is done for performance reasons and to give the user the ability to parse only the objects and pages of interest.

The Hyperlinks list will be populated if PDFParsePagesOptions.Hyperlinks is passed as part of the options parameter to PDFDocument.ParsePages. After this method returns, all the pages parsed will have their Hyperlinks properties populated either with a list of the hyperlinks found in the page or an empty list (with IList.Count equals to 0).

When parsing is finished, the Objects and Hyperlinks properties will contain a list of the PDFObject and PDFHyperlink items found in the page (if PDFParsePagesOptions.Objects and PDFParsePagesOptions.Hyperlinks was selected). Each of these items contain a PDFTextProperties object that contain the text properties of the item such its font information and color. One of these properties is PDFTextProperties.FontIndex which is the 0-based integer index to the font of the item in the Fonts list.

If PDFParsePagesOptions.Fonts is not passed to PDFDocument.ParsePages, but PDFParsePagesOptions.Objects and PDFParsePagesOptions.Hyperlinks was selected, then the fonts are not parsed and the PDFTextProperties.FontIndex value of any returned object will be 0.

Example

For an example on general parsing of PDF pages, refer to PDFDocumentPage, for an example on drawing the objects of a page on the surface of an image, refer to PDFObject.

Requirements

Target Platforms

Reference

PDFDocumentPage Class

PDFDocumentPage Members

Download our FREE evaluation

Help Version 20.0.2020.4.3