Documentation – Creating Form Field

Python-Net: Create CheckBox Field

Thu, 05 Mar 2026 00:00:00 +0000

PDF forms are widely used for collecting user input in documents such as applications, surveys, and agreements. A checkbox field enables users to select or deselect an option within a form.

Using Aspose.PDF for Python, developers can manipulate PDF forms programmatically. The FormEditor class provides methods to add, edit, and manage form fields within a PDF document.

Load an existing PDF file.
Call the ‘add_field()’ method with the ‘FieldType.CHECK_BOX’ parameter to create the checkbox and specify its position.
Define the field name, caption, and position.
Save the updated PDF document.

import sys
from os import path
import aspose.pdf.facades as pdf_facades

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def create_checkbox_field(infile, outfile):
    """Create CheckBox field in PDF document."""
    pdf_form_editor = pdf_facades.FormEditor()
    pdf_form_editor.bind_pdf(infile)

    # Add CheckBox field to PDF form
    pdf_form_editor.add_field(
        pdf_facades.FieldType.CHECK_BOX,
        "checkbox1",
        "Check Box 1",
        1,
        240,
        498,
        256,
        514,
    )

    # Save updated PDF document with form fields
    pdf_form_editor.save(outfile)

Python-Net: Create ComboBox Field

Thu, 05 Mar 2026 00:00:00 +0000

PDF forms are widely used for collecting structured information in digital documents such as applications, surveys, and registration forms. A ComboBox field provides a convenient way for users to choose from a list of predefined values while keeping the form compact and organized.

The FormEditor class allows you to create and manage different types of fields, including text boxes, checkboxes, radio buttons, and drop-down lists.

Load an existing PDF document.
Add a ComboBox field with ‘add_field()’ method and ‘FieldType.COMBO_BOX’ parameter.
Use the ‘add_list_item()’ method to insert selectable options into the drop-down list.
Save the updated PDF document.

import sys
from os import path
import aspose.pdf.facades as pdf_facades

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def create_combobox_field(infile, outfile):
    """Create ComboBox field in PDF document."""
    pdf_form_editor = pdf_facades.FormEditor()
    pdf_form_editor.bind_pdf(infile)

    # Add ComboBox field to PDF form
    pdf_form_editor.add_field(
        pdf_facades.FieldType.COMBO_BOX, "combobox1", "Australia", 1, 230, 498, 350, 514
    )
    pdf_form_editor.add_list_item("combobox1", ["Australia", "Australia"])
    pdf_form_editor.add_list_item("combobox1", ["New Zealand", "New Zealand"])

    # Save updated PDF document with form fields
    pdf_form_editor.save(outfile)

Python-Net: Create ListBox Field

Thu, 05 Mar 2026 00:00:00 +0000

PDF forms are commonly used for applications, surveys, and registration documents. A ListBox field displays multiple options simultaneously, making it easier for users to review and select items from a list.

The FormEditor class provides functionality for adding different types of interactive fields, including ListBox elements.

Load an existing PDF document.
Define a list of selectable options.
Add a ListBox field to a specific page.
Set a default selected value.
Save the updated PDF document.

import sys
from os import path
import aspose.pdf.facades as pdf_facades

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def create_listbox_field(infile, outfile):
    """Create ListBox field in PDF document."""
    pdf_form_editor = pdf_facades.FormEditor()
    pdf_form_editor.bind_pdf(infile)

    # Add ListBox field to PDF form
    pdf_form_editor.items = ["Australia", "New Zealand", "Malaysia"]
    pdf_form_editor.add_field(
        pdf_facades.FieldType.LIST_BOX, "listbox1", "Australia", 1, 230, 398, 350, 514
    )

    # Save updated PDF document with form fields
    pdf_form_editor.save(outfile)

Python-Net: Create RadioButton Field

Thu, 05 Mar 2026 00:00:00 +0000

Interactive PDF forms enable users to provide structured input directly within a document. A radio button field is useful when users must choose only one option from multiple choices, such as selecting a country, gender, or preference.

The FormEditor class provides methods to create different types of fields, including text boxes, checkboxes, combo boxes, list boxes, and radio buttons.

Load an existing PDF document.
Define a list of radio button options.
Add a radio button field to a specific page.
Set a default selected value.
Save the modified PDF document.

import sys
from os import path
import aspose.pdf.facades as pdf_facades

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def create_radiobutton_field(infile, outfile):
    """Create RadioButton field in PDF document."""
    pdf_form_editor = pdf_facades.FormEditor()
    pdf_form_editor.bind_pdf(infile)

    # Add RadioButton field to PDF form
    pdf_form_editor.items = ["Australia", "New Zealand", "Malaysia"]
    pdf_form_editor.add_field(
        pdf_facades.FieldType.RADIO, "radiobutton1", "Malaysia", 1, 240, 498, 256, 514
    )

    # Save updated PDF document with form fields
    pdf_form_editor.save(outfile)

Python-Net: Create Submit Button

Thu, 05 Mar 2026 00:00:00 +0000

Interactive PDF forms often require users to submit their input for processing, such as sending survey results, application forms, or feedback data. A Submit Button field provides this functionality by linking the button to a web endpoint.

The FormEditor class allows adding buttons, checkboxes, radio buttons, text fields, and other form controls.

Load an existing PDF document.
Add a Submit Button field to a specific page.
Set the button label and target submission URL.
Save the updated PDF with the new button.

import sys
from os import path
import aspose.pdf.facades as pdf_facades

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def create_submit_button(infile, outfile):
    """Create Submit Button in PDF document."""
    pdf_form_editor = pdf_facades.FormEditor()
    pdf_form_editor.bind_pdf(infile)

    # Add Submit Button to PDF form
    pdf_form_editor.add_submit_btn(
        "submitbtn1",
        1,
        "Submit Button",
        "http://example.com/submit",
        100,
        450,
        200,
        470,
    )

    # Save updated PDF document with form fields
    pdf_form_editor.save(outfile)

Python-Net: Create TextBox Field

Thu, 05 Mar 2026 00:00:00 +0000

PDF forms often require text input from users, such as names, addresses, or comments. TextBox fields enable this functionality by providing editable fields directly within the PDF document.

The FormEditor class allows adding text fields, checkboxes, radio buttons, list boxes, combo boxes, and buttons, making it easy to build interactive PDFs.

Load an existing PDF document.
Add multiple TextBox fields for user input.
Set default values for each field.
Save the updated PDF document.

import sys
from os import path
import aspose.pdf.facades as pdf_facades

sys.path.append(path.join(path.dirname(__file__), ".."))

from config import set_license, initialize_data_dir


def create_textbox_field(infile, outfile):
    """Create TextBox field in PDF document."""
    pdf_form_editor = pdf_facades.FormEditor()
    pdf_form_editor.bind_pdf(infile)

    # Add TextBox field to PDF form
    pdf_form_editor.add_field(
        pdf_facades.FieldType.TEXT, "first_name", "Alexander", 1, 50, 570, 150, 590
    )
    pdf_form_editor.add_field(
        pdf_facades.FieldType.TEXT, "last_name", "Smith", 1, 235, 570, 330, 590
    )

    # Save updated PDF document with form fields
    pdf_form_editor.save(outfile)