Create ListBox Field

Contents
[ ]

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.

  1. Load an existing PDF document.
  2. Define a list of selectable options.
  3. Add a ListBox field to a specific page.
  4. Set a default selected value.
  5. 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)