Documentation – Links and Navigation

Python-Net: Add Application Link

Fri, 20 Mar 2026 00:00:00 +0000

PDF can include interactive elements such as links that launch external applications. Using PdfContentEditor, you can define a rectangular region on a page that, when clicked, opens a specific executable file.

Create a PdfContentEditor instance.
Bind the input PDF document.
Define a rectangle area for the clickable link.
Specifie the application path to launch.
Set the link color.
Save the updated PDF document.

import aspose.pdf.facades as pdf_facades
from aspose.pycore import cast, is_assignable
import aspose.pydrawing as apd
import aspose.pdf as ap

import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_application_link(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add application launch link
    content_editor.create_application_link(
        apd.Rectangle(180, 530, 260, 20),
        "notepad.exe",
        1,
        apd.Color.purple,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Custom Action Link

Fri, 20 Mar 2026 00:00:00 +0000

Custom action links allow you to define interactive areas in a PDF that can trigger specific actions when clicked, such as executing scripts, navigating pages, or running application-specific commands. Using PdfContentEditor, you can create a custom action link by specifying the page, rectangle, color, and actions.

Create a PdfContentEditor instance.
Bind the input PDF document.
Define a rectangle for the clickable link.
Specifie the page number and link color.
Assign custom actions (empty in this example).
Save the updated PDF document.

import aspose.pdf.facades as pdf_facades
from aspose.pycore import cast, is_assignable
import aspose.pydrawing as apd
import aspose.pdf as ap

import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_custom_action_link(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add custom action link. Empty action list keeps the sample runnable
    # without requiring additional enum lookups.
    content_editor.create_custom_action_link(
        apd.Rectangle(200, 500, 260, 20),
        1,
        apd.Color.dark_red,
        [],
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add JavaScript Link

Fri, 20 Mar 2026 00:00:00 +0000

JavaScript links in PDFs allow interactive functionality such as displaying alerts, performing calculations, or dynamically modifying document content. Using PdfContentEditor, you can define a clickable rectangle on a page and associate it with custom JavaScript code.

Create a PdfContentEditor instance.
Bind the input PDF document.
Define a rectangle for the clickable JavaScript link.
Specifie the page number and link color.
Assign JavaScript code to execute when clicked.
Save the updated PDF document.

import aspose.pdf.facades as pdf_facades
from aspose.pycore import cast, is_assignable
import aspose.pydrawing as apd
import aspose.pdf as ap

import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_javascript_link(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add JavaScript link action
    content_editor.create_java_script_link(
        "app.alert('PdfContentEditor JavaScript link');",
        apd.Rectangle(160, 560, 260, 20),
        1,
        apd.Color.orange,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Local Link

Fri, 20 Mar 2026 00:00:00 +0000

Local links in PDFs allow quick navigation between pages within the same document. Using PdfContentEditor, you can define a clickable rectangle that links one page to another, improving document usability and navigation.

Create a PdfContentEditor instance.
Bind the input PDF document.
Define a rectangle for the clickable local link.
Specifie the source page and destination page.
Set the link color.
Save the updated PDF document.

import aspose.pdf.facades as pdf_facades
from aspose.pycore import cast, is_assignable
import aspose.pydrawing as apd
import aspose.pdf as ap

import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_local_link(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add a local link on page 1 to destination page 1
    content_editor.create_local_link(
        apd.Rectangle(120, 620, 220, 20),
        1,
        1,
        apd.Color.red,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add PDF Document Link

Fri, 20 Mar 2026 00:00:00 +0000

PDF document links allow users to navigate from one PDF to another seamlessly. Using PdfContentEditor, you can define a clickable rectangle that links to a page in a different PDF file, making your documents interactive and connected.

Create a PdfContentEditor instance.
Bind the input PDF document.
Define a rectangle for the clickable link.
Specifie the linked PDF file, source page, and destination page.
Set the link color.
Save the updated PDF document.

import aspose.pdf.facades as pdf_facades
from aspose.pycore import cast, is_assignable
import aspose.pydrawing as apd
import aspose.pdf as ap

import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_pdf_document_link(infile, linked_pdf, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add link to another PDF document
    content_editor.create_pdf_document_link(
        apd.Rectangle(140, 590, 240, 20),
        linked_pdf,
        1,
        1,
        apd.Color.green,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Add Web Link

Fri, 20 Mar 2026 00:00:00 +0000

Web links in PDFs allow users to navigate directly to online resources, websites, or documentation. Using PdfContentEditor, you can define a rectangular area on a PDF page that, when clicked, opens a URL in the default web browser.

Create a PdfContentEditor instance.
Bind the input PDF document.
Define a rectangle for the clickable web link.
Specifie the URL, page number, and link color.
Save the updated PDF document.

import aspose.pdf.facades as pdf_facades
from aspose.pycore import cast, is_assignable
import aspose.pydrawing as apd
import aspose.pdf as ap

import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def add_web_link(infile, outfile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Add a web link annotation to page 1
    content_editor.create_web_link(
        apd.Rectangle(100, 650, 200, 20),
        "https://products.aspose.com/pdf/python-net/",
        1,
        apd.Color.blue,
    )
    # Save updated document
    content_editor.save(outfile)

Python-Net: Extract Links

Fri, 20 Mar 2026 00:00:00 +0000

PDF often contain interactive elements such as web links, document links, and custom actions. Using PdfContentEditor, you can programmatically extract all link annotations from a PDF. This allows you to inspect or process links, for example, to validate URLs or analyze navigation patterns in a document.

Create a PdfContentEditor instance.
Bind the input PDF document.
Extract all links using ’extract_link()'.
Iterate through extracted links.
Check if a link is a LinkAnnotation and if its action is a GoToURIAction.
Print the rectangle coordinates and the URI.
Display a message if no links are found.

import aspose.pdf.facades as pdf_facades
from aspose.pycore import cast, is_assignable
import aspose.pydrawing as apd
import aspose.pdf as ap

import sys
from os import path

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def extract_links(infile):
    # Create PdfContentEditor object
    content_editor = pdf_facades.PdfContentEditor()
    # Bind document to PdfContentEditor
    content_editor.bind_pdf(infile)
    # Extract links from the document
    links = content_editor.extract_link()

    count = 0
    for link in links:
        count += 1
        print(f"Link {count}: {link.rect}")
        if is_assignable(link, ap.annotations.LinkAnnotation):
            annotation = cast(ap.annotations.LinkAnnotation, link)
            if is_assignable(annotation.action, ap.annotations.GoToURIAction):
                action = cast(ap.annotations.GoToURIAction, annotation.action)
                print(f"  URI: {action.uri}")

    if count == 0:
        print("No links found")