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

PdfWidgetAnnotation

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

Represents a widget annotation (form field).

from nutrient_sdk import PdfWidgetAnnotation

Inherits from: PdfAnnotation

Construction

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

Properties

alternate_field_name 

@property
def alternate_field_name(self) -> str

The alternate field name for display.

Type: str

Read-only property.

field_name 

@property
def field_name(self) -> str

The field name (partial name).

Type: str

Read-only property.

field_type 

@property
def field_type(self) -> str

The field type (Tx, Btn, Ch, Sig).

Type: str

Read-only property.

is_button 

@property
def is_button(self) -> bool

Whether this is a button (checkbox, radio button, or push button).

Type: bool

Read-only property.

is_choice_field 

@property
def is_choice_field(self) -> bool

Whether this is a choice field (combo box or list box).

Type: bool

Read-only property.

is_signature_field 

@property
def is_signature_field(self) -> bool

Whether this is a signature field.

Type: bool

Read-only property.

is_text_field 

@property
def is_text_field(self) -> bool

Whether this is a text field.

Type: bool

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