Class PdfAcroFormManager

Manages AcroForm fields in PDF documents. Provides methods to read and write form field values.

Index

Constructors

Methods

exists read write

Constructors

constructor

new PdfAcroFormManager(document: PdfDocument): PdfAcroFormManager
Parameters
- document: PdfDocument
Returns PdfAcroFormManager
- Defined in packages/pdf-lite/src/acroform/manager.ts:11

Methods

exists

exists(): Promise<boolean>
Checks if the document contains AcroForm fields.

Returns Promise<boolean>
True if the document has AcroForm fields, false otherwise
- Defined in packages/pdf-lite/src/acroform/manager.ts:19

read

read(): Promise<PdfAcroForm<Record<string, string>> | null>
Gets the AcroForm object from the document catalog.

Returns Promise<PdfAcroForm<Record<string, string>> | null>
The AcroForm object or null if not found
- Defined in packages/pdf-lite/src/acroform/manager.ts:32

write

write(acroForm: PdfAcroForm): Promise<void>
Writes the provided AcroForm to the associated PDF document.
Parameters
- acroForm: PdfAcroForm
  The AcroForm instance to serialize into the document.
Returns Promise<void>
Throws
Error If writing the AcroForm to the document fails.
- Defined in packages/pdf-lite/src/acroform/manager.ts:41