(As of 3.3.011.01)

Use InternalLink and InternalLinkAnchor to create clickable jump links inside a PDF document. This allows users to click text in one location and instantly jump to another object elsewhere in the PDF.

Overview

An internal PDF link consists of two parts:

• InternalLinkAnchor
  The destination object the user should jump to.

• InternalLink
  The clickable link that points to that anchor.

Both values must use the same identifier.

How It Works

Create the Destination Anchor

Add an InternalLinkAnchor tag to the object that should become the jump destination.

Example:

Object name: DogsTextLabel

Tag: InternalLinkAnchor GoDogs

This marks the object as a destination named GoDogs.

Create the Clickable Link

Add an InternalLink tag to the text or object that the user will click.

Example text: Dogs ..........

Tag: InternalLink GoDogs

When the PDF is generated, clicking the text will jump to the object containing:

InternalLinkAnchor  GoDogs

Example

Destination Object

Object: DogsTextLabel

Tag: InternalLinkAnchor  GoDogs

Clickable Link

Text: Dogs ..........

Tag: InternalLink  GoDogs

Result:

• Clicking Dogs .......... in the PDF jumps to DogsTextLabel

Rules

• InternalLink and InternalLinkAnchor must use the exact same identifier

• Identifiers are case-sensitive

• Anchors must exist before links can resolve correctly

• Multiple links may point to the same anchor

• Internal links only work in generated PDFs

Common Use Cases

• Table of contents

• Cross-references

• Jump-to-section navigation

• Appendix references

• Glossary navigation

• Large report navigation

Tips

• Use descriptive anchor names such as:

  • Introduction

  • Chapter3

  • AppendixA

  • GoDogs

• Keep anchor names unique within the document

• Internal links work best for long PDFs with multiple sections