Function main

examples/03-forms/read-form-fields.ts:13–144

()

import { loadFixture } from "../utils";

async function main() {
  console.log("Reading form fields from a PDF...\n");

  // Load a PDF with form fields
  const bytes = await loadFixture("forms", "fancy_fields.pdf");
  const pdf = await PDF.load(bytes);

  // Check if the document has a form
  if (!pdf.hasForm()) {
    console.log("This PDF does not contain a form.");
    return;
  }

  // Get the form
  const form = pdf.getForm();
  if (!form) {
    console.log("Could not load form.");
    return;
  }

  console.log("=== Form Overview ===");
  console.log(`Total fields: ${form.fieldCount}`);
  console.log(`Is empty: ${form.isEmpty}`);
  console.log("");

  // Get all field names
  const fieldNames = form.getFieldNames();
  console.log("=== Field Names ===");
  for (const name of fieldNames) {
    console.log(`  - ${name}`);
  }
  console.log("");

  // Iterate through all fields and show their details
  console.log("=== Field Details ===\n");
  const fields = form.getFields();

  for (const field of fields) {
    console.log(`Field: "${field.name}"`);
    console.log(`  Type: ${field.type}`);
    console.log(`  Read-only: ${field.isReadOnly()}`);
    console.log(`  Required: ${field.isRequired()}`);

    // Show type-specific information
    switch (field.type) {
      case "text": {
        const textField = form.getTextField(field.name);
        if (textField) {
          const value = textField.getValue();
          console.log(`  Value: "${value ?? "(empty)"}"`);
          console.log(`  Max length: ${textField.maxLength ?? "unlimited"}`);
          console.log(`  Multiline: ${textField.isMultiline}`);
        }
        break;
      }

      case "checkbox": {
        const checkbox = form.getCheckbox(field.name);