Class PdfXfaForm

Typed wrapper around the XFA name/stream-ref array. Holds eagerly-loaded references to component streams like datasets.

Hierarchy (View Summary)

PdfArray
- PdfXfaForm

Index

Constructors

constructor

new PdfXfaForm(items?: PdfObject[]): PdfXfaForm
Parameters
- items: PdfObject[] = []
Returns PdfXfaForm
Inherited from PdfArray.constructor
- Defined in packages/pdf-lite/src/core/objects/pdf-array.ts:10

Properties

datasets

datasets: PdfXfaData | null = null

`Protected`immutable

immutable: boolean = false

Indicates whether the object is immutable (cannot be modified)

innerTokens

innerTokens: PdfWhitespaceToken[] = []

items

items: PdfObject[]

`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

length

get length(): number
Returns number
Inherited from PdfArray.length
- Defined in packages/pdf-lite/src/core/objects/pdf-array.ts:15

objectType

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

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

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 PdfArray.as
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:77

clone

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

Returns this
Inherited from PdfArray.clone
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:91

cloneImpl

cloneImpl(): this
Creates a deep clone of the object. Override this method in subclasses to ensure all properties are cloned correctly

Returns this
Inherited from PdfArray.cloneImpl
- Defined in packages/pdf-lite/src/core/objects/pdf-array.ts:45

equals

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

isImmutable

isImmutable(): boolean
Indicates whether the object is immutable (cannot be modified)

Returns boolean
Inherited from PdfArray.isImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:34

isModified

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

Returns boolean
Inherited from PdfArray.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-array.ts:50

push

push(item: PdfObject): void
Parameters
- item: PdfObject
Returns void
Inherited from PdfArray.push
- Defined in packages/pdf-lite/src/core/objects/pdf-array.ts:19

setImmutable

setImmutable(immutable?: boolean): void
Sets the immutable state of the object
Parameters
- Optionalimmutable: boolean
Returns void
Inherited from PdfArray.setImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-array.ts:56

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 PdfArray.setModified
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:29

toBytes

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

`Protected`tokenize

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

Returns PdfToken[]
Inherited from PdfArray.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-array.ts:23

toString

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

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

toTokens

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

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

`Static`fromDocument

fromDocument(document: PdfDocument): Promise<PdfXfaForm | null>
Parameters
- document: PdfDocument
Returns Promise<PdfXfaForm | null>
- Defined in packages/pdf-lite/src/acroform/xfa/pdf-xfa-form.ts:17

Class PdfXfaForm

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfXfaForm

Properties

datasets

Protectedimmutable

innerTokens

items

Protectedmodified

OptionalpostTokens

OptionalpreTokens

Accessors

length

Returns number

objectType

Returns string

Methods

as

Type Parameters

Parameters

Returns T

clone

Returns this

cloneImpl

Returns this

equals

Parameters

Returns boolean

isImmutable

Returns boolean

isModified

Returns boolean

push

Parameters

Returns void

setImmutable

Parameters

Returns void

setModified

Parameters

Returns void

toBytes

Parameters

Returns ByteArray

Protectedtokenize

Returns PdfToken[]

toString

Returns string

toTokens

Returns PdfToken[]

StaticfromDocument

Parameters

Returns Promise<PdfXfaForm | null>

Settings

On This Page

`Protected`immutable

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize

`Static`fromDocument