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

Represents a push button form field in a PDF document. Push buttons respond immediately to user input without retaining a permanent value. They are typically used to trigger actions like submit, reset, or JavaScript execution.

from nutrient_sdk import PdfPushButtonField

Inherits from: PdfFormField

Construction

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

Properties

background_color

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

The background color of the button.

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 button.

Type: Color


caption

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

The caption text displayed on the button.

Type: str


font_color

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

The font color for the button caption text.

Type: Color


font_name

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

The font name for the button caption text.

Type: str


font_size

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

The font size for the button caption text.

Type: float


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