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

editors.pdf.formfields

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

API reference for the editors.pdf.formfields module.

# All public classes import directly from the top-level package:
from nutrient_sdk import PdfCheckBoxField

Classes

ClassDescription
PdfCheckBoxFieldRepresents a check box form field in a PDF document. Check boxes toggle between two states: checked and unchecked.
PdfComboBoxFieldRepresents a combo box (drop-down list) form field in a PDF document. Combo boxes display a list of options and may optionally allow custom text entry.
PdfFormFieldRepresents a form field in a PDF document. Form fields can be terminal (with widget annotations) or non-terminal (with child fields). This is the base class for all form field types. Use the specific subclasses (PdfTextField, PdfCheckBoxField, PdfRadioButtonField, etc.) for type-specific functionality.
PdfFormFieldCollectionRepresents a collection of form fields in a PDF document. Provides access to the top-level form fields in the document’s AcroForm.
PdfListBoxFieldRepresents a list box form field in a PDF document. List boxes display a scrollable list of options for selection.
PdfPushButtonFieldRepresents 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.
PdfRadioButtonFieldRepresents a radio button form field in a PDF document. Radio buttons are part of a mutually exclusive group where only one option can be selected.
PdfSignatureFieldRepresents a signature form field in a PDF document. Signature fields are used for electronic signatures.
PdfTextFieldRepresents a text form field in a PDF document. Text fields allow users to enter text from the keyboard.