pdfAcroForm

Typing of the Catalog's /AcroForm dict — ISO 32000-2 §12.7.3.

Module pdfAcroForm | Source packages/front/office/pdf/src/form/acroform.js | Deps pdfErrors, pdfParser | Worker-safe yes

The Catalog's /AcroForm describes the interactive-forms layer: root /Fields, /NeedAppearances, /SigFlags (bit 1 = SignaturesExist, bit 2 = AppendOnly), /CO (calculation order), /DR (default Resources), /DA (default appearance), /Q (default quadding, 0=left/1=center/2=right). /XFA (legacy 1.7) is preserved verbatim in _extras for 2.0 fidelity. Any unknown entry is also captured in _extras.

Resolve

const af = runtime.resolve('pdfAcroForm');
// Returns: { typeAcroForm }

API

Shape AcroForm

{
    fields:          Array<{num:number, gen:number}>,
    needAppearances: boolean,        // default false
    sigFlags:        number,         // default 0
    co:              Array<{num,gen}>, // calculation order
    dr:              object|null,    // /DR dict
    da:              Uint8Array|null,// /DA bytes
    q:               number,         // default 0
    raw:             object,
    _extras:         { [key]: PdfObject }   // /XFA + others
}

/Fields is required by §12.7.3 but a degenerate AcroForm dict without it is tolerated (result []).

Examples

Typing from the Catalog

const af = runtime.resolve('pdfAcroForm');
if (doc.catalog.acroForm) {
    const form = af.typeAcroForm(doc._raw.resolve(doc.catalog.acroForm));
    form.fields.length;
    (form.sigFlags & 1) !== 0;  // SignaturesExist
    (form.sigFlags & 2) !== 0;  // AppendOnly
}

Walking the roots

const ft = runtime.resolve('pdfFieldTree');
const records = ft.walkFieldTree(form.fields, doc._raw.resolve);

XFA preservation

form._extras.XFA;  // typed array/stream — passed through as-is to the writer

Errors

See also

• pdfFieldTree — walks fields.
• pdfButtonField, pdfTextField, pdfChoiceField, pdfSignatureField — typing by /FT.
• pdfCatalog — carries acroForm.