Class PdfAcroForm<T>

Type Parameters

T extends Record<string, string> = Record<string, string>

Hierarchy (View Summary)

PdfDictionary<
    {
        CO?: PdfArray<PdfObjectReference>;
        DA?: PdfString;
        DR?: PdfDictionary;
        Fields: PdfArray<PdfObjectReference>;
        NeedAppearances?: PdfBoolean;
        Q?: PdfNumber;
        SigFlags?: PdfNumber;
    },
>
- PdfAcroForm

Index

Constructors

constructor

new PdfAcroForm<T extends Record<string, string> = Record<string, string>>(
    options: {
        container?: PdfIndirectObject<PdfObject>;
        dict: PdfDictionary;
        document?: PdfDocument;
        fields?: PdfAcroFormField[];
    },
): PdfAcroForm<T>
Type Parameters
- T extends Record<string, string> = Record<string, string>
Parameters
- options: {
      container?: PdfIndirectObject<PdfObject>;
      dict: PdfDictionary;
      document?: PdfDocument;
      fields?: PdfAcroFormField[];
  }
Returns PdfAcroForm<T>
Overrides PdfDictionary.constructor
- Defined in packages/pdf-lite/src/acroform/acroform.ts:419

Properties

`Optional` `Readonly`container

container?: PdfIndirectObject<PdfObject>

fields

fields: PdfAcroFormField[]

`Readonly`fontEncodingMaps

fontEncodingMaps: Map<string, Map<number, string> | null> = ...

innerTokens

innerTokens: PdfToken[] = []

`Protected`modified

modified: boolean = true

Indicates whether the object has been modified. By default, assume it has been modified because it's a new object

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

Accessors

defaultAppearance

get defaultAppearance(): string | null
Gets the default appearance string for the form

Returns string | null
- Defined in packages/pdf-lite/src/acroform/acroform.ts:463
set defaultAppearance(da: string): void
Sets the default appearance string for the form
Parameters
- da: string
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:470

defaultQuadding

get defaultQuadding(): number
Gets the default quadding (alignment) for the form 0 = left, 1 = center, 2 = right

Returns number
- Defined in packages/pdf-lite/src/acroform/acroform.ts:478
set defaultQuadding(q: number): void
Sets the default quadding (alignment) for the form
Parameters
- q: number
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:485

needAppearances

get needAppearances(): boolean
Gets the NeedAppearances flag

Returns boolean
- Defined in packages/pdf-lite/src/acroform/acroform.ts:435
set needAppearances(value: boolean): void
Sets the NeedAppearances flag to indicate that appearance streams need to be regenerated
Parameters
- value: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:442

objectType

get objectType(): string
The type of this PDF object

Returns string
Inherited from PdfDictionary.objectType
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:17

signatureFlags

get signatureFlags(): number
Gets the signature flags

Returns number
- Defined in packages/pdf-lite/src/acroform/acroform.ts:449
set signatureFlags(flags: number): void
Sets the signature flags
Parameters
- flags: number
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:456

values

get values(): { readonly [K in string]: T[K] }
Returns { readonly [K in string]: T[K] }
Inherited from PdfDictionary.values
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:94

Methods

as

as<T extends PdfObject>(ctor: new (...args: any[]) => T): T
Attempts to cast the object to a specific PdfObject subclass
Type Parameters
- T extends PdfObject
Parameters
- ctor: new (...args: any[]) => T
Returns T
Inherited from PdfDictionary.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:65

clone

clone(): this
Creates a deep clone of the object

Returns this
Inherited from PdfDictionary.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:169

copyFrom

copyFrom(other: PdfDictionary<any>): void
Parameters
- other: PdfDictionary<any>
Returns void
Inherited from PdfDictionary.copyFrom
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:162

delete

delete<
    K extends
        "Q"
        | "DA"
        | "Fields"
        | "NeedAppearances"
        | "SigFlags"
        | "CO"
        | "DR",
>(
    key: K | PdfName<K>,
): void
Type Parameters
- K extends "Q" | "DA" | "Fields" | "NeedAppearances" | "SigFlags" | "CO" | "DR"
Parameters
- key: K | PdfName<K>
Returns void
Inherited from PdfDictionary.delete
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:63

entries

entries(): IterableIterator<[string, PdfObject | undefined]>
Returns an iterator for the dictionary entries. Each entry is a tuple of [key string, value].

Returns IterableIterator<[string, PdfObject | undefined]>
Inherited from PdfDictionary.entries
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:111

equals

equals(other?: PdfObject): boolean
Compares this object to another for equality based on their token representations
Parameters
- Optionalother: PdfObject
Returns boolean
Inherited from PdfDictionary.equals
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:79

exportData

exportData(): Partial<T>
Returns Partial<T>
- Defined in packages/pdf-lite/src/acroform/acroform.ts:511

get

get<
    K extends
        "Q"
        | "DA"
        | "Fields"
        | "NeedAppearances"
        | "SigFlags"
        | "CO"
        | "DR",
>(
    key: K | PdfName<K>,
):
    | {
        CO?: PdfArray<PdfObjectReference>;
        DA?: PdfString;
        DR?: PdfDictionary<PdfDictionaryEntries>;
        Fields: PdfArray<PdfObjectReference>;
        NeedAppearances?: PdfBoolean;
        Q?: PdfNumber;
        SigFlags?: PdfNumber;
    }[K]
    | undefined
Type Parameters
- K extends "Q" | "DA" | "Fields" | "NeedAppearances" | "SigFlags" | "CO" | "DR"
Parameters
- key: K | PdfName<K>
Returns
    | {
        CO?: PdfArray<PdfObjectReference>;
        DA?: PdfString;
        DR?: PdfDictionary<PdfDictionaryEntries>;
        Fields: PdfArray<PdfObjectReference>;
        NeedAppearances?: PdfBoolean;
        Q?: PdfNumber;
        SigFlags?: PdfNumber;
    }[K]
    | undefined
Inherited from PdfDictionary.get
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:29

getFontEncodingMap

getFontEncodingMap(fontName: string): Promise<Map<number, string> | null>
Gets the encoding map for a specific font in the form's resources. Returns null if no custom encoding is found. Results are cached for performance.
Parameters
- fontName: string
Returns Promise<Map<number, string> | null>
- Defined in packages/pdf-lite/src/acroform/acroform.ts:527

has

has<
    K extends
        "Q"
        | "DA"
        | "Fields"
        | "NeedAppearances"
        | "SigFlags"
        | "CO"
        | "DR",
>(
    key: K | PdfName<K>,
): boolean
Type Parameters
- K extends "Q" | "DA" | "Fields" | "NeedAppearances" | "SigFlags" | "CO" | "DR"
Parameters
- key: K | PdfName<K>
Returns boolean
Inherited from PdfDictionary.has
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:81

importData

importData(fields: T): void
Parameters
- fields: T
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:502

isModified

isModified(): boolean
Indicates whether the object has been modified. Override this method if the modified state is determined differently

Returns boolean
Inherited from PdfDictionary.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:177

set

set<
    K extends
        "Q"
        | "DA"
        | "Fields"
        | "NeedAppearances"
        | "SigFlags"
        | "CO"
        | "DR",
>(
    key: K | PdfName<K>,
    value: {
        CO?: PdfArray<PdfObjectReference>;
        DA?: PdfString;
        DR?: PdfDictionary<PdfDictionaryEntries>;
        Fields: PdfArray<PdfObjectReference>;
        NeedAppearances?: PdfBoolean;
        Q?: PdfNumber;
        SigFlags?: PdfNumber;
    }[K],
): void
Type Parameters
- K extends "Q" | "DA" | "Fields" | "NeedAppearances" | "SigFlags" | "CO" | "DR"
Parameters
- key: K | PdfName<K>
- value: {
      CO?: PdfArray<PdfObjectReference>;
      DA?: PdfString;
      DR?: PdfDictionary<PdfDictionaryEntries>;
      Fields: PdfArray<PdfObjectReference>;
      NeedAppearances?: PdfBoolean;
      Q?: PdfNumber;
      SigFlags?: PdfNumber;
  }[K]
Returns void
Inherited from PdfDictionary.set
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:43

setModified

setModified(modified?: boolean): void
Sets the modified state of the object. Override this method if the modified state is determined differently
Parameters
- modified: boolean = true
Returns void
Inherited from PdfDictionary.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:27

setValues

setValues(values: Partial<T>): void
Sets multiple field values by field name.
Parameters
- values: Partial<T>
  Object with field names as keys and values to set
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:493

toBytes

toBytes(padTo?: number): ByteArray
Converts the object to a ByteArray, optionally padding to a specified length
Parameters
- OptionalpadTo: number
Returns ByteArray
Inherited from PdfDictionary.toBytes
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:41

`Protected`tokenize

tokenize(): PdfToken[]
Tokenizes the object into an array of PdfTokens

Returns PdfToken[]
Inherited from PdfDictionary.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:119

toString

toString(): string
Converts the object to a string representation

Returns string
Inherited from PdfDictionary.toString
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:56

toTokens

toTokens(): PdfToken[]
Converts the object to an array of PdfTokens, including any pre or post tokens

Returns PdfToken[]
Inherited from PdfDictionary.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:32

write

write(document: PdfDocument): Promise<void>
Parameters
- document: PdfDocument
Returns Promise<void>
- Defined in packages/pdf-lite/src/acroform/acroform.ts:833

`Static`fromDocument

fromDocument(
document: PdfDocument,
): Promise<PdfAcroForm<Record<string, string>> | null>
Parameters
- document: PdfDocument
Returns Promise<PdfAcroForm<Record<string, string>> | null>
- Defined in packages/pdf-lite/src/acroform/acroform.ts:597

Class PdfAcroForm<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PdfAcroForm<T>

Properties

Optional Readonlycontainer

fields

ReadonlyfontEncodingMaps

innerTokens

Protectedmodified

OptionalpostTokens

OptionalpreTokens

Accessors

defaultAppearance

Returns string | null

Parameters

Returns void

defaultQuadding

Returns number

Parameters

Returns void

needAppearances

Returns boolean

Parameters

Returns void

objectType

Returns string

signatureFlags

Returns number

Parameters

Returns void

values

Returns { readonly [K in string]: T[K] }

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

copyFrom

Parameters

Returns void

delete

Type Parameters

Parameters

Returns void

entries

Returns IterableIterator<[string, PdfObject | undefined]>

equals

Parameters

Returns boolean

exportData

Returns Partial<T>

get

Type Parameters

Parameters

Returns | { CO?: PdfArray<PdfObjectReference>; DA?: PdfString; DR?: PdfDictionary<PdfDictionaryEntries>; Fields: PdfArray<PdfObjectReference>; NeedAppearances?: PdfBoolean; Q?: PdfNumber; SigFlags?: PdfNumber; }[K] | undefined

getFontEncodingMap

Parameters

Returns Promise<Map<number, string> | null>

has

Type Parameters

Parameters

Returns boolean

importData

Parameters

Returns void

isModified

Returns boolean

set

`Optional` `Readonly`container

`Readonly`fontEncodingMaps

`Protected`modified

`Optional`postTokens

`Optional`preTokens

Returns
| {
CO?: PdfArray<PdfObjectReference>;
DA?: PdfString;
DR?: PdfDictionary<PdfDictionaryEntries>;
Fields: PdfArray<PdfObjectReference>;
NeedAppearances?: PdfBoolean;
Q?: PdfNumber;
SigFlags?: PdfNumber;
}[K]
| undefined

`Protected`tokenize

`Static`fromDocument