PdfWidgetAnnotation

Represents a widget annotation (form field).

from nutrient import PdfWidgetAnnotation

Methods

set_border_style

def set_border_style(self, value: PdfBorderStyle) -> None

Parameters:

set_border_width

def set_border_width(self, value: float) -> None

Parameters:

set_color

def set_color(self, value: Color) -> None

Parameters:

set_contents

def set_contents(self, value: str) -> None

Parameters:

set_is_hidden

def set_is_hidden(self, value: bool) -> None

Parameters:

set_is_printable

def set_is_printable(self, value: bool) -> None

Parameters:

set_rect

def set_rect(self, value: Any) -> None

Parameters:

set_title

def set_title(self, value: str) -> None

Parameters:

Properties

alternate_field_name

@property
def alternate_field_name(self) -> str

Gets the alternate field name for display.

Type: str

Read-only property.

border_style

@property
def border_style(self) -> PdfBorderStyle

Type: PdfBorderStyle

Read-only property.

border_width

@property
def border_width(self) -> float

Type: float

Read-only property.

color

@property
def color(self) -> Color

Type: Color

Read-only property.

contents

@property
def contents(self) -> str

Type: str

Read-only property.

field_name

@property
def field_name(self) -> str

Gets the field name (partial name).

Type: str

Read-only property.

field_type

@property
def field_type(self) -> str

Gets the field type (Tx, Btn, Ch, Sig).

Type: str

Read-only property.

index

@property
def index(self) -> int

Type: int

Read-only property.

is_button

@property
def is_button(self) -> bool

Gets 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

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

Type: bool

Read-only property.

is_hidden

@property
def is_hidden(self) -> bool

Type: bool

Read-only property.

is_printable

@property
def is_printable(self) -> bool

Type: bool

Read-only property.

is_signature_field

@property
def is_signature_field(self) -> bool

Gets whether this is a signature field.

Type: bool

Read-only property.

is_text_field

@property
def is_text_field(self) -> bool

Gets whether this is a text field.

Type: bool

Read-only property.

modification_date

@property
def modification_date(self) -> str

Type: str

Read-only property.

name

@property
def name(self) -> str

Type: str

Read-only property.

rect

@property
def rect(self) -> Any

Type: Any

Read-only property.

sub_type

@property
def sub_type(self) -> str

Type: str

Read-only property.

title

@property
def title(self) -> str

Type: str

Read-only property.