BCL easyPDF SDK
easyPDF SDK Usermanual
PDF Creator Programming API  |  Download Free Trial  |  Contact Us to Purchase

ExtractAllHyperlinks Method

Extracts all hyperlinks from a PDF file and return an XML string to the caller.
The data contained in the XML string can be used to invoke AddHyperlink function in BCL easyPDF SDK for creating hyperlinks in PDF file.

 Function ExtractAllHyperlinks(InputFileName As String, [Optional] Password As String) As String
 String ExtractAllHyperlinks(string InputFileName, string Password)
 String ExtractAllHyperlinks(String InputFileName, String Password) throws PDFProcessorException

Parameters

InputFileName

Input file name.

Password (optional)

A password string for opening the document, if the document is encrypted.

Return Values

String in an XML format.

Sample XML string will look like the following:

<?xml version="1.0" encoding="utf-8" ?>
<Hyperlinks>
<Hyperlink id="1" page="0" left="50" top="80" right="370" bottom="100" url="http://www.bcltechnologies.com/"/> <Hyperlink id="2" page="1" left="60" top="90" right="380" bottom="120" url="http://www.pdfonline.com/"/>
<Hyperlink id="3" page="3" left="70" top="100" right="390" bottom="120" url="http://www.bcltechnologies.com/"/> .........................................
.........................................
</Hyperlinks>

Remarks

Note: New attributes can be added to Hyperlink element if needed.
Assumption: The user needs to know how to parse data from an XML string.

Example Usage

Set oProcessor = CreateObject("easyPDF.PDFProcessor.8")
oProcessor.ExtractAllHyperlinks "C:\test\input.pdf", "password"