PdfAnnotation

Represents a base annotation in a PDF document.

from nutrient_sdk import PdfAnnotation

Construction

Properties

blend_mode

@property
def blend_mode(self) -> str

The blend mode of the annotation (e.g., “Normal”, “Multiply”). Returns an empty string if no blend mode is explicitly set on the annotation, which indicates the default/unspecified blend mode.

Type: str

Read-only property.

border_effect

@property
def border_effect(self) -> str

The border effect style (e.g., “S” for solid/no effect, “C” for cloudy).

Type: str

Read-only property.

border_effect_intensity

@property
def border_effect_intensity(self) -> float

The border effect intensity (0 = no effect, higher values = more pronounced).

Type: float

Read-only property.

border_style

@property
def border_style(self) -> PdfBorderStyle

@border_style.setter
def border_style(self, value: PdfBorderStyle) -> None

The border style of the annotation.

Type: PdfBorderStyle

border_width

@property
def border_width(self) -> float

@border_width.setter
def border_width(self, value: float) -> None

The border width of the annotation in points.

Type: float

color

@property
def color(self) -> Color

@color.setter
def color(self, value: Color) -> None

The annotation color.

Type: Color

contents

@property
def contents(self) -> str

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

The annotation’s text contents.

Type: str

index

@property
def index(self) -> int

The 0-based index of this annotation in the page’s annotation array.

Type: int

Read-only property.

is_hidden

@property
def is_hidden(self) -> bool

@is_hidden.setter
def is_hidden(self, value: bool) -> None

Whether the annotation is hidden.

Type: bool

is_printable

@property
def is_printable(self) -> bool

@is_printable.setter
def is_printable(self, value: bool) -> None

Whether the annotation is printable.

Type: bool

modification_date

@property
def modification_date(self) -> str

The annotation’s modification date.

Type: str

Read-only property.

name

@property
def name(self) -> str

The annotation’s unique name/identifier.

Type: str

Read-only property.

rect

@property
def rect(self) -> Optional[RectF]

@rect.setter
def rect(self, value: Optional[RectF]) -> None

The rectangle that defines the location and size of the annotation on the page.

Type: Optional[RectF]

sub_type

@property
def sub_type(self) -> str

The annotation subtype (e.g., “Text”, “Link”, “Highlight”).

Type: str

Read-only property.

title

@property
def title(self) -> str

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

The annotation’s title/author.

Type: str

Inheritors

• PdfLinkAnnotation
• PdfMarkupAnnotation
• PdfWidgetAnnotation