Documentation – Reading Form Values

Python-Net: Get Field Facades

Thu, 19 Feb 2026 00:00:00 +0000

PDF forms contain fields where users can enter data, such as text boxes, checkboxes, or radio buttons. To process these forms programmatically, it is often necessary to retrieve the current values of these fields.

Create a Form object.
Bind the PDF document to the form object.
Retrieve Field Values.


    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


    # Get field values
    def get_field_values(infile):
        """Get field values from a PDF document."""
        # Create Form object
        pdf_form = pdf_facades.Form()

        # Bind PDF document
        pdf_form.bind_pdf(infile)

        # Get field values by their names
        field_names = ["First Name", "Last Name"]
        for field_name in field_names:
            value = pdf_form.get_field(field_name)
            print(f"Value of '{field_name}': {value}")

Python-Net: Get Radio Button Options

Thu, 19 Feb 2026 00:00:00 +0000

Radio button fields in PDF forms are grouped controls where only one option can be selected at a time. Each group has a field name, and each option has a corresponding value.

Create a Form Object.
Bind the PDF Document.
Retrieve the Selected Radio Button Option.

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


# Get radio button options
def get_radio_button_options(infile):
    """Get radio button options from a PDF document."""
    # Create Form object
    pdf_form = pdf_facades.Form()

    # Bind PDF document
    pdf_form.bind_pdf(infile)

    # Get radio button options by their names
    field_names = ["WorkType"]
    for field_name in field_names:
        options = pdf_form.get_button_option_current_value(field_name)
        print(f"Options for '{field_name}': {options}")

Python-Net: Get Required Field Names

Thu, 19 Feb 2026 00:00:00 +0000

PDF forms may contain mandatory fields that users must complete before submission. These fields are typically marked as required in the form’s properties.

Create a Form Object.
Bind the PDF Document.
Access all field names using ‘pdf_form.field_names’.

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


# Get required field names
def get_required_field_names(infile):
    """Get required field names from a PDF document."""
    # Create Form object
    pdf_form = pdf_facades.Form()

    # Bind PDF document
    pdf_form.bind_pdf(infile)

    # Get required field names
    for field in pdf_form.field_names:
        if pdf_form.is_required_field(field):
            print(f"Required field: {field}")

Python-Net: Get Rich Text Values

Thu, 19 Feb 2026 00:00:00 +0000

PDF forms may include text fields that support rich text formatting. These fields can store content with styling attributes in addition to plain text values.

Create a Form Object.
Bind the PDF Document.
Retrieve Rich Text Values.

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


# Get rich text values
def get_rich_text_values(infile):
    """Get rich text values from a PDF document."""
    # Create Form object
    pdf_form = pdf_facades.Form()

    # Bind PDF document
    pdf_form.bind_pdf(infile)

    # Get rich text values by their names
    field_names = ["Summary"]
    for field_name in field_names:
        rich_text_value = pdf_form.get_rich_text(field_name)
        print(f"Rich text value of '{field_name}': {rich_text_value}")

Python-Net: Get Field Values

Thu, 19 Feb 2026 00:00:00 +0000

This code snippet shows how to retrieve the current values of form fields from a PDF document using Aspose.PDF Facades API. The get_field() method allows you to programmatically access data entered into text fields, checkboxes, radio buttons, and other AcroForm elements.

Bind the PDF to a Form object.
Specify the field names you want to read.
Retrieve each field’s value using get_field().


    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


    # Get field values
    def get_field_values(infile):
        """Get field values from a PDF document."""
        # Create Form object
        pdf_form = pdf_facades.Form()

        # Bind PDF document
        pdf_form.bind_pdf(infile)

        # Get field values by their names
        field_names = ["First Name", "Last Name"]
        for field_name in field_names:
            value = pdf_form.get_field(field_name)
            print(f"Value of '{field_name}': {value}")

Python-Net: Resolve Full Field Names

Thu, 19 Feb 2026 00:00:00 +0000

In PDF forms, fields can be organized hierarchically, especially when subforms are used. Each field has a short name and a fully qualified name. The fully qualified name represents the complete path of the field within the form hierarchy and is required by many API methods that manipulate or read form data.

Create a Form Object.
Bind the PDF Document.
Access all form field names.
Each field’s fully qualified name is resolved using get_full_field_name().

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


# Resolve full field names
def resolve_full_field_names(infile):
    """Resolve full field names in a PDF document."""
    # Create Form object
    pdf_form = pdf_facades.Form()

    # Bind PDF document
    pdf_form.bind_pdf(infile)

    # Resolve full field names
    for field in pdf_form.field_names:
        name = pdf_form.get_full_field_name(field)
        print(f"Full field name: {name}")