Documentation – Adding Scripts and Submit Actions

Python-Net: Add Field Script

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

Add JavaScript Actions to PDF Form Fields Using Python

This code snippet enables you to add JavaScript actions to an existing PDF form field using the Aspose.PDF for Python library. It opens a PDF document, assigns a JavaScript action to a form field, and adds a script that runs when the field is triggered. Finally, the updated PDF is saved as a new file. Using the FormEditor class from the aspose.pdf.facades module, you can programmatically attach JavaScript to existing form fields:

Open an existing PDF form.
Set a JavaScript action for a specific field.
Append another JavaScript action to the same field.
Save the modified PDF document.

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

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

from config import set_license, initialize_data_dir


def add_field_script(input_file_name, output_file_name):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()

    # Open input PDF file
    form_editor.bind_pdf(input_file_name)

    # Set JavaScript action for the field
    form_editor.set_field_script(
        "Script_Demo_Button", "app.alert('Script 1 has been executed');"
    )

    # Add JavaScript action to the field
    form_editor.add_field_script(
        "Script_Demo_Button", "app.alert('Script 2 has been executed');"
    )

    # Save output PDF file
    form_editor.save(output_file_name)

Python-Net: Remove Field Action

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

PDF forms often contain JavaScript actions that execute when users interact with form elements such as buttons or input fields. In some cases, these scripts must be removed to simplify form behavior, improve security, or update the form logic. Remove a JavaScript action from a form field in a PDF document using Aspose.PDF for Python. The code opens an existing PDF form, locates a specific field, removes its associated JavaScript action, and saves the updated document as a new PDF file.

Using the FormEditor class from the aspose.pdf.facades, you can remove JavaScript actions from specific fields in an existing PDF form:

Open an existing PDF form.
Locate a form field named ‘Script_Demo_Button’.
Remove the JavaScript action associated with that field.
Check whether the removal was successful.
Save the updated PDF document.

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

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

from config import set_license, initialize_data_dir


def remove_field_script(input_file_name, output_file_name):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()

    # Open input PDF file
    form_editor.bind_pdf(input_file_name)

    # Remove JavaScript action from the field
    if not form_editor.remove_field_action("Script_Demo_Button"):
        raise Exception("Failed to remove field script")

    # Save output PDF file
    form_editor.save(output_file_name)

Python-Net: Set Field Script

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

Interactive PDF forms often rely on JavaScript to perform tasks such as displaying alerts, validating input, or triggering dynamic form behavior. With Aspose.PDF for Python, developers can programmatically manage these scripts.

The example first adds a JavaScript action to the field and then replaces it with another script using the ‘set_field_script’ method. This approach allows developers to control or update the interactive behavior of PDF form elements such as buttons or input fields.

The form field used in this example is named ‘Script_Demo_Button’, which typically represents a button that executes the assigned script when triggered.

Using the FormEditor class from the aspose.pdf.facades module, developers can programmatically manage JavaScript actions associated with form fields:

Open an existing PDF form document.
Add a JavaScript action to a form field.
Set (replace) the JavaScript action with a new script.
Save the modified PDF document.

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

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

from config import set_license, initialize_data_dir


def set_field_script(input_file_name, output_file_name):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()

    # Open input PDF file
    form_editor.bind_pdf(input_file_name)

    # Add JavaScript action to the field
    form_editor.add_field_script(
        "Script_Demo_Button", "app.alert('Script 1 has been executed');"
    )

    # Set JavaScript action for the field
    form_editor.set_field_script(
        "Script_Demo_Button", "app.alert('Script 2 has been executed');"
    )

    # Save output PDF file
    form_editor.save(output_file_name)

Python-Net: Set Submit Url

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

PDF forms can be designed to submit their data to a web server when a user clicks a submit button. Using Aspose.PDF for Python, developers can programmatically configure a submit action for form fields. By setting a submit URL, the form can send user-entered data to a server when the button is clicked. This functionality is useful for workflows where PDF forms must submit information to web applications, databases, or processing services.

Using the FormEditor class from the aspose.pdf.facades module, developers can programmatically assign a submit URL to a button field in an existing PDF form.

Open an existing PDF form.
Locate a button field named Script_Demo_Button.
Assign a URL where the form data will be submitted.
Verify that the action was successfully applied.
Save the updated PDF document.

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

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

from config import set_license, initialize_data_dir


def set_submit_url(input_file_name, output_file_name):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()

    # Set license
    set_license()

    # Open input PDF file
    form_editor.bind_pdf(input_file_name)

    # Set submit URL for the button
    if not form_editor.set_submit_url(
        "Script_Demo_Button", "http://www.example.com/submit"
    ):
        raise Exception("Failed to set submit URL")

    # Save output PDF file
    form_editor.save(output_file_name)

Python-Net: Set Submit Flag

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

PDF forms often include Submit Buttons to send user input to a server. The submit flag determines the data format sent (e.g., XFDF, FDF, HTML).

Bind a PDF document.
Access an existing submit button.
Set the submit flag for the desired format.
Save the updated PDF document.

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

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

from config import set_license, initialize_data_dir


def set_submit_flag(input_file_name, output_file_name):
    # Create FormEditor object
    form_editor = pdf_facades.FormEditor()

    # Open input PDF file
    form_editor.bind_pdf(input_file_name)

    # Set submit flag for the form
    form_editor.set_submit_flag("Script_Demo_Button", ap.facades.SubmitFormFlag.XFDF)

    # Save output PDF file
    form_editor.save(output_file_name)