PdfCheckBoxField

Represents a check box form field in a PDF document. Check boxes toggle between two states: checked and unchecked.

from nutrient_sdk import PdfCheckBoxField

Inherits from: PdfFormField

Construction

Properties

background_color

@property
def background_color(self) -> Color

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

The background color of the check box.

Type: Color

border_color

@property
def border_color(self) -> Color

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

The border color of the check box.

Type: Color

is_checked

@property
def is_checked(self) -> bool

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

Whether the check box is currently checked.

Type: bool

on_state_name

@property
def on_state_name(self) -> str

Gets the “on” state name for this check box. This is the value used when the check box is checked (often “Yes” or “On”).

Type: str

Read-only property.

Inherited members

From PdfFormField: child, child_count, default_value, field_type, full_name, is_read_only, is_required, is_terminal, name, parent, value, widget, widget_count, remove_child_at