Link Annotation

Link annotations allow users to navigate to another location within the document or to an external resource, such as a web page. Adding hyperlinks to a PDF makes the document interactive and improves navigation.

The link is typically associated with a specific area on the page and can trigger actions such as opening a URL. For more information about link annotations, see PDF Specification 2.0, Section 12.5.6.5.

Use the LinkAnnotation class to add links to a PDF document.

Add a Hyperlink

To add a hyperlink:

Create a PdfDocument.
Draw text or define an area that represents the hyperlink.
Create a LinkAnnotation and add it to the page’s annotations collection.

const doc = new PdfDocument();
const page = doc.pages.addNew();
const ctx = page.context;
const inch = ctx.resolution;

const url = "https://www.google.com/";
const tf = new Format({ fontSize: 20, foreColor: "DarkBlue", underline: true });

// Draw the linked text:
const tl = new Layout({
    marginAll: inch,
    maxWidth: ctx.width,
    maxHeight: ctx.height,
    runs: [{ text: "Google, Google on the wall, please tell me all!", format: tf }],
});
ctx.drawLayout(tl, 0, 0);

// Add a link annotation using the text layout’s computed bounds:
const link = new LinkAnnotation();
link.rect = tl.contentRect;
link.action = new ActionURI(url);
page.annotations.add(link);

const docData = doc.savePdf();
Util.saveFile("LinkAnnotation.pdf", docData);