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

PdfTextAnnotation

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

Represents a text annotation (sticky note) in a PDF document.

from nutrient_sdk import PdfTextAnnotation

Inherits from: PdfMarkupAnnotation

Construction

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

Properties

icon_name 

@property
def icon_name(self) -> str


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

The icon name for the annotation. Valid values: Comment, Key, Note, Help, NewParagraph, Paragraph, Insert

Type: str

is_open 

@property
def is_open(self) -> bool


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

Whether the annotation popup should initially be open.

Type: bool

state 

@property
def state(self) -> str

The state of the annotation (for review workflows).

Type: str

Read-only property.

state_model 

@property
def state_model(self) -> str

The state model (e.g., “Marked”, “Review”).

Type: str

Read-only property.

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

From PdfMarkupAnnotation: creation_date, opacity, rich_text_contents, subject