Documentation – Modifying Form Fields

Python-Net: Add List Item

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

List box fields in PDFs allow users to select one or multiple options from a predefined set. Using Aspose.PDF for Python, developers can programmatically add new items to these fields. The FormEditor class provides the ‘add_list_item’ method to append items to an existing list box field.

Open an existing PDF form.
Create a FormEditor object.
Bind the PDF to the FormEditor.
Add items to the list box field “Country”.
Save the updated document.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def add_list_item(infile, outfile):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(infile)
    # Add list item to list box field
    form_editor.add_list_item("Country", ["New Zealand", "New Zealand"])
    # Save updated document
    form_editor.save(outfile)

Python-Net: Copy Inner Field

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

PDF forms often require duplicating fields while maintaining the original formatting and behavior. Using Aspose.PDF for Python, developers can copy an existing field to a new position on the same or another page programmatically.

This article explains how to copy a field named ‘First Name’ to a new field called ‘First Name Copy’ on page 2 at specific coordinates (x=200, y=600), producing a PDF with the newly positioned field.

Open an existing PDF form.
Create a FormEditor object.
Bind the PDF document to the FormEditor.
Copy the ‘First Name’ field to a new field ‘First Name Copy’ on page 2 at coordinates (200, 600).
Save the updated document.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def copy_inner_field(infile, outfile):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(infile)
    # Copies an existing field to a new position specified by both page number and ordinates.
    # A new document will be produced, which contains everything the source document has except for the newly copied field.
    form_editor.copy_inner_field("First Name", "First Name Copy", 2, 200, 600)
    # Save updated document
    form_editor.save(outfile)

Please note:

The ‘copy_inner_field’ method signature looks like this:

copy_inner_field(original_field_name, new_field_name, page_number, x, y)

‘original_field_name’ – the field you want to duplicate.
’new_field_name’ – the name of the new field.
‘page_number’ – the page on which the new field will appear.
x, y – coordinates on that page.

The page_number is expected to be a positive integer corresponding to an existing page in the PDF (1-based indexing).

If you pass a negative parameter, e.g.:

form_editor.copy_inner_field("First Name", "First Name Copy", -1, 200, 600)

The program will then reset to the previous parameters.

Python-Net: Copy Outer Field

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

Sometimes, PDF forms require reusing fields from one document in another. Using Aspose.PDF for Python, developers can programmatically copy form fields from a source PDF to a target PDF.

The FormEditor class provides the ‘copy_outer_field’ method, which copies a field from a source document to a target document at a specified page and coordinates.

The code creates a new PDF (target), adds a page, and then copies a field from an existing PDF (source) to the target document at specified coordinates.

Create a new target PDF document.
Add at least one page to the target PDF.
Save the empty target document.
Create a FormEditor object and bind it to the target PDF.
Copy the ‘First Name’ field from the source PDF to page 1 at (200, 600).
Save the updated target PDF.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def copy_outer_field(infile, outfile):
    # Since copy_outer_field() method needs to copy field from source document to target document, we need to create a new document as target document first.
    doc = ap.Document()
    doc.pages.add()
    doc.save(outfile)

    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(outfile)
    # Copies an existing field to a new position specified by both page number and ordinates.
    # A new document will be produced, which contains everything the source document has except for the newly copied field.
    form_editor.copy_outer_field(infile, "First Name", 1, 200, 600)
    # Save updated document
    form_editor.save(outfile)

Please note:

The ‘copy_outer_field’ method signature looks like this:

copy_outer_field(original_field_name, new_field_name, page_number, x, y)

‘original_field_name’ – the field you want to duplicate.
’new_field_name’ – the name of the new field.
‘page_number’ – the page on which the new field will appear.
x, y – coordinates on that page.

The page_number is expected to be a positive integer corresponding to an existing page in the PDF (1-based indexing).

If you pass a negative parameter, e.g.:

form_editor.copy_outer_field("First Name", "First Name Copy", 1, -200, 600)

The program will then reset to the previous parameters.

Python-Net: Delete List Item

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

List box fields in PDFs allow users to select one or multiple predefined options. Using Aspose.PDF for Python, developers can programmatically remove items from these fields.

This article explains how to delete the ‘UK’ item from a list box field named ‘Country’, ensuring the field only contains the desired options.

The FormEditor class provides the ‘del_list_item’ method to remove a specific item from a list box field.

Open an existing PDF form.
Create a FormEditor object.
Bind the PDF document to the FormEditor.
Delete the “UK” item from the “Country” list box field.
Save the updated document.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def del_list_item(infile, outfile):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(infile)
    # Delete list item from list box field
    form_editor.del_list_item("Country", "UK")
    # Save updated document
    form_editor.save(outfile)

Python-Net: Move Field

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

PDF forms often require layout adjustments after creation. Using Aspose.PDF for Python, developers can move existing form fields to a new position without recreating them.

This example shows how to reposition the “Country” field by specifying new coordinates for its placement within the page. The FormEditor class provides the move_field method to relocate fields within a PDF page.

Open the existing PDF form.
Create a FormEditor object.
Bind the PDF document to the FormEditor.
Move the ‘Country’ field to a new position using coordinates.
Save the modified document.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def move_field(infile, outfile):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(infile)
    # Move field to new page
    form_editor.move_field("Country", 200, 600, 280, 620)
    # Save updated document
    form_editor.save(outfile)

Python-Net: Remove Field

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

PDF forms may contain fields that are no longer needed due to design changes or workflow updates. With Aspose.PDF for Python, developers can easily remove specific form fields programmatically.

The FormEditor class in Aspose.PDF provides the ‘remove_field’ method, which allows developers to delete a form field by its name.

Load the PDF document.
Create a FormEditor object.
Bind the PDF to the FormEditor.
Remove the specified form field.
Save the updated document.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def remove_field(infile, outfile):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(infile)
    # Remove field from document
    form_editor.remove_field("Country")
    # Save updated document
    form_editor.save(outfile)

Python-Net: Rename Field

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

PDF forms often rely on field names for scripting, automation, and data processing. Using Aspose.PDF for Python, developers can rename existing fields without recreating them or altering the form layout.

The FormEditor class provides the ‘rename_field’ method, which allows developers to change the name of an existing field while preserving its position, value, and appearance.

Load the existing PDF form.
Create a FormEditor instance.
Bind the PDF document to the editor.
Rename the target field.
Save the updated PDF.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def rename_field(infile, outfile):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(infile)
    # Rename field in document
    form_editor.rename_field("City", "Town")
    # Save updated document
    form_editor.save(outfile)

Python-Net: Single-Line Field to Multi-Line Field

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

PDF forms sometimes contain text fields designed for single-line input, which may not be sufficient for certain types of data. With Aspose.PDF for Python, developers can easily convert such fields into multi-line text fields without recreating them.

Using the FormEditor class, developers can modify existing text fields without affecting their position or other properties.

Load the existing PDF document.
Create a FormEditor instance.
Bind the PDF document to the editor.
Convert the selected field to multi-line.
Save the updated document.

from io import FileIO
import sys
from os import path
import aspose.pdf as ap
import aspose.pdf.facades as pdf_facades

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

from config import set_license, initialize_data_dir


def single2multiple(infile, outfile):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()
    # Bind document to FormEditor
    form_editor.bind_pdf(infile)
    # Change a single-lined text field to a multiple-lined one
    form_editor.single_2_multiple("City")
    # Save updated document
    form_editor.save(outfile)