---
title: "PdfLinkAnnotation"
canonical_url: "https://www.nutrient.io/api/python/editors/pdf/annotations/pdf-link-annotation/"
md_url: "https://www.nutrient.io/api/python/editors/pdf/annotations/pdf-link-annotation.md"
last_updated: "2026-06-09T10:32:42.528Z"
description: "Represents a link annotation that can navigate to a destination or perform an action."
---

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

```python

from nutrient_sdk import PdfLinkAnnotation

```

**Inherits from:** [`PdfAnnotation`](/api/python/editors/pdf/annotations/pdf-annotation/)

## Construction

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

## Methods

### set_destination

```python

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:**

| Name          | Type              | Description                                                                               |
| ------------- | ----------------- | ----------------------------------------------------------------------------------------- |
| `page_number` | `int`             | The 1-based destination page number.                                                      |
| `x`           | `Optional[float]` | Optional X coordinate on the destination page. If null, the view scrolls to the top-left. |
| `y`           | `Optional[float]` | Optional Y coordinate on the destination page. If null, the view scrolls to the top-left. |

---

## Properties

### destination_page_index

```python

@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

```python

@property
def highlighting_mode(self) -> str

```

The highlighting mode for the link.

**Type:** `str`

*Read-only property.*

---

### uri

```python

@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`](../pdf-annotation/): `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`

---

## Related pages

- [All public classes import directly from the top-level package:](/api/python/editors/pdf/annotations.md)
- [Pdf Annotation](/api/python/editors/pdf/annotations/pdf-annotation.md)
- [Pdf Circle Annotation](/api/python/editors/pdf/annotations/pdf-circle-annotation.md)
- [Pdf Annotation Collection](/api/python/editors/pdf/annotations/pdf-annotation-collection.md)
- [Pdf Highlight Annotation](/api/python/editors/pdf/annotations/pdf-highlight-annotation.md)
- [Pdf Line Annotation](/api/python/editors/pdf/annotations/pdf-line-annotation.md)
- [Pdf Markup Annotation](/api/python/editors/pdf/annotations/pdf-markup-annotation.md)
- [Pdf Shape Annotation](/api/python/editors/pdf/annotations/pdf-shape-annotation.md)
- [Pdf Redact Annotation](/api/python/editors/pdf/annotations/pdf-redact-annotation.md)
- [Pdf Free Text Annotation](/api/python/editors/pdf/annotations/pdf-free-text-annotation.md)
- [Pdf Square Annotation](/api/python/editors/pdf/annotations/pdf-square-annotation.md)
- [Pdf Squiggly Annotation](/api/python/editors/pdf/annotations/pdf-squiggly-annotation.md)
- [Pdf Stamp Annotation](/api/python/editors/pdf/annotations/pdf-stamp-annotation.md)
- [Pdf Strike Out Annotation](/api/python/editors/pdf/annotations/pdf-strike-out-annotation.md)
- [Pdf Underline Annotation](/api/python/editors/pdf/annotations/pdf-underline-annotation.md)
- [Pdf Text Annotation](/api/python/editors/pdf/annotations/pdf-text-annotation.md)
- [Pdf Widget Annotation](/api/python/editors/pdf/annotations/pdf-widget-annotation.md)