This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/python/editors/pdf/annotations/pdf-link-annotation.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. PdfLinkAnnotation

PdfLinkAnnotation

Markdown version of this page, suitable for AI agents and automation

Represents a link annotation that can navigate to a destination or perform an action.

from nutrient_sdk import PdfLinkAnnotation

Inherits from: PdfAnnotation

Construction

PdfLinkAnnotation cannot be instantiated directly. Obtain instances through static factory methods or via other SDK classes.

Methods

set_destination 

def set_destination(self, page_number: int, x: Optional[float], y: Optional[float]) -> None

Sets the link destination to navigate to a specific page in the document.

Parameters:

NameTypeDescription
page_numberintThe 1-based destination page number.
xOptional[float]Optional X coordinate on the destination page. If null, the view scrolls to the top-left.
yOptional[float]Optional Y coordinate on the destination page. If null, the view scrolls to the top-left.

Properties

destination_page_index 

@property
def destination_page_index(self) -> int

The destination page index (0-based) if this link has an internal page destination. Returns -1 if no page destination is found.

Type: int

Read-only property.

highlighting_mode 

@property
def highlighting_mode(self) -> str

The highlighting mode for the link.

Type: str

Read-only property.

uri 

@property
def uri(self) -> str


@uri.setter
def uri(self, value: str) -> None

The URI for this link annotation. Setting a non-empty value creates a URI action; setting empty removes any existing action.

Type: str

Inherited members

From PdfAnnotation: blend_mode, border_effect, border_effect_intensity, border_style, border_width, color, contents, index, is_hidden, is_printable, modification_date, name, rect, sub_type, title