Class PdfAcroFormField

Hierarchy (View Summary)

PdfDictionary<
    {
        AS?: PdfName;
        BS?: PdfDictionary;
        DA?: PdfString;
        DV?: PdfString
        | PdfName;
        F?: PdfNumber;
        Ff?: PdfNumber;
        FT: PdfName<PdfFieldType>;
        Kids?: PdfArray<PdfObjectReference>;
        MK?: PdfDictionary;
        P?: PdfObjectReference;
        Rect?: PdfArray<PdfNumber>;
        Subtype?: PdfName<"Widget">;
        T?: PdfString;
        Type?: PdfName<"Annot">;
        V?: PdfString | PdfName;
    },
>
- PdfAcroFormField

Index

Constructors

Constructors

constructor

new PdfAcroFormField(
    options?: {
        container?: PdfIndirectObject<PdfObject>;
        form?: PdfAcroForm<Record<string, string>>;
    },
): PdfAcroFormField
Parameters
- Optionaloptions: {
  container?: PdfIndirectObject<PdfObject>;
  form?: PdfAcroForm<Record<string, string>>;
  }
Returns PdfAcroFormField
Overrides PdfDictionary.constructor
- Defined in packages/pdf-lite/src/acroform/acroform.ts:49

Properties

`Optional` `Readonly`container

container?: PdfIndirectObject<PdfObject>

`Optional`form

form?: PdfAcroForm<Record<string, string>>

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`parent

parent?: PdfAcroFormField

`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

checked

get checked(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/acroform.ts:219
set checked(isChecked: boolean): void
Parameters
- isChecked: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:228

defaultValue

get defaultValue(): string
Gets the default value

Returns string
- Defined in packages/pdf-lite/src/acroform/acroform.ts:143
set defaultValue(val: string): void
Sets the default value
Parameters
- val: string
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:156

fieldType

get fieldType(): PdfFieldType | null
Gets the field type

Returns PdfFieldType | null
- Defined in packages/pdf-lite/src/acroform/acroform.ts:61
set fieldType(type: PdfFieldType | null): void
Parameters
- type: PdfFieldType | null
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:65

flags

get flags(): number
Gets field flags (bitwise combination of field attributes)

Returns number
- Defined in packages/pdf-lite/src/acroform/acroform.ts:318
set flags(flags: number): void
Sets field flags
Parameters
- flags: number
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:325

font

set font(font: PdfFont | null): void
Sets the font using a PdfFont object. Pass null to clear the font.
Parameters
- font: PdfFont | null
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:289

fontName

get fontName(): string | null
Returns string | null
- Defined in packages/pdf-lite/src/acroform/acroform.ts:263
set fontName(fontName: string): void
Parameters
- fontName: string
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:272

isWidget

get isWidget(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/acroform.ts:103
set isWidget(isWidget: boolean): void
Parameters
- isWidget: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:109

multiline

get multiline(): boolean
Checks if the field is multiline (for text fields)

Returns boolean
- Defined in packages/pdf-lite/src/acroform/acroform.ts:368
set multiline(isMultiline: boolean): void
Sets the field as multiline (for text fields)
Parameters
- isMultiline: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:375

name

get name(): string
Gets the field name

Returns string
- Defined in packages/pdf-lite/src/acroform/acroform.ts:122
set name(name: string): void
Sets the field name
Parameters
- name: string
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:136

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

parentRef

get parentRef(): PdfObjectReference | null
Returns PdfObjectReference | null
- Defined in packages/pdf-lite/src/acroform/acroform.ts:90
set parentRef(ref: PdfObjectReference | null): void
Parameters
- ref: PdfObjectReference | null
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:95

password

get password(): boolean
Checks if the field is a password field (for text fields)

Returns boolean
- Defined in packages/pdf-lite/src/acroform/acroform.ts:386
set password(isPassword: boolean): void
Sets the field as a password field (for text fields)
Parameters
- isPassword: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:393

readOnly

get readOnly(): boolean
Checks if the field is read-only

Returns boolean
- Defined in packages/pdf-lite/src/acroform/acroform.ts:332
set readOnly(isReadOnly: boolean): void
Sets the field as read-only or editable
Parameters
- isReadOnly: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:339

rect

get rect(): number[] | null
Returns number[] | null
- Defined in packages/pdf-lite/src/acroform/acroform.ts:73
set rect(rect: number[] | null): void
Parameters
- rect: number[] | null
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:79

required

get required(): boolean
Checks if the field is required

Returns boolean
- Defined in packages/pdf-lite/src/acroform/acroform.ts:350
set required(isRequired: boolean): void
Sets the field as required or optional
Parameters
- isRequired: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:357

value

get value(): string
Returns string
- Defined in packages/pdf-lite/src/acroform/acroform.ts:165
set value(val: string): void
Parameters
- val: string
Returns void
- Defined in packages/pdf-lite/src/acroform/acroform.ts:204

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
        | "Type"
        | "V"
        | "P"
        | "T"
        | "F"
        | "Subtype"
        | "FT"
        | "DV"
        | "DA"
        | "AS"
        | "Kids"
        | "Rect"
        | "Ff"
        | "BS"
        | "MK",
>(
    key: K | PdfName<K>,
): void
Type Parameters
- K extends
      | "Type"
      | "V"
      | "P"
      | "T"
      | "F"
      | "Subtype"
      | "FT"
      | "DV"
      | "DA"
      | "AS"
      | "Kids"
      | "Rect"
      | "Ff"
      | "BS"
      | "MK"
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

get

get<
    K extends
        | "Type"
        | "V"
        | "P"
        | "T"
        | "F"
        | "Subtype"
        | "FT"
        | "DV"
        | "DA"
        | "AS"
        | "Kids"
        | "Rect"
        | "Ff"
        | "BS"
        | "MK",
>(
    key: K | PdfName<K>,
):
    | {
        AS?: PdfName<string>;
        BS?: PdfDictionary<PdfDictionaryEntries>;
        DA?: PdfString;
        DV?: PdfName<string> | PdfString;
        F?: PdfNumber;
        Ff?: PdfNumber;
        FT: PdfName<PdfFieldType>;
        Kids?: PdfArray<PdfObjectReference>;
        MK?: PdfDictionary<PdfDictionaryEntries>;
        P?: PdfObjectReference;
        Rect?: PdfArray<PdfNumber>;
        Subtype?: PdfName<"Widget">;
        T?: PdfString;
        Type?: PdfName<"Annot">;
        V?: PdfName<string> | PdfString;
    }[K]
    | undefined
Type Parameters
- K extends
      | "Type"
      | "V"
      | "P"
      | "T"
      | "F"
      | "Subtype"
      | "FT"
      | "DV"
      | "DA"
      | "AS"
      | "Kids"
      | "Rect"
      | "Ff"
      | "BS"
      | "MK"
Parameters
- key: K | PdfName<K>
Returns
    | {
        AS?: PdfName<string>;
        BS?: PdfDictionary<PdfDictionaryEntries>;
        DA?: PdfString;
        DV?: PdfName<string> | PdfString;
        F?: PdfNumber;
        Ff?: PdfNumber;
        FT: PdfName<PdfFieldType>;
        Kids?: PdfArray<PdfObjectReference>;
        MK?: PdfDictionary<PdfDictionaryEntries>;
        P?: PdfObjectReference;
        Rect?: PdfArray<PdfNumber>;
        Subtype?: PdfName<"Widget">;
        T?: PdfString;
        Type?: PdfName<"Annot">;
        V?: PdfName<string> | PdfString;
    }[K]
    | undefined
Inherited from PdfDictionary.get
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:29

has

has<
    K extends
        | "Type"
        | "V"
        | "P"
        | "T"
        | "F"
        | "Subtype"
        | "FT"
        | "DV"
        | "DA"
        | "AS"
        | "Kids"
        | "Rect"
        | "Ff"
        | "BS"
        | "MK",
>(
    key: K | PdfName<K>,
): boolean
Type Parameters
- K extends
      | "Type"
      | "V"
      | "P"
      | "T"
      | "F"
      | "Subtype"
      | "FT"
      | "DV"
      | "DA"
      | "AS"
      | "Kids"
      | "Rect"
      | "Ff"
      | "BS"
      | "MK"
Parameters
- key: K | PdfName<K>
Returns boolean
Inherited from PdfDictionary.has
- Defined in packages/pdf-lite/src/core/objects/pdf-dictionary.ts:81

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
        | "Type"
        | "V"
        | "P"
        | "T"
        | "F"
        | "Subtype"
        | "FT"
        | "DV"
        | "DA"
        | "AS"
        | "Kids"
        | "Rect"
        | "Ff"
        | "BS"
        | "MK",
>(
    key: K | PdfName<K>,
    value: {
        AS?: PdfName<string>;
        BS?: PdfDictionary<PdfDictionaryEntries>;
        DA?: PdfString;
        DV?: PdfName<string> | PdfString;
        F?: PdfNumber;
        Ff?: PdfNumber;
        FT: PdfName<PdfFieldType>;
        Kids?: PdfArray<PdfObjectReference>;
        MK?: PdfDictionary<PdfDictionaryEntries>;
        P?: PdfObjectReference;
        Rect?: PdfArray<PdfNumber>;
        Subtype?: PdfName<"Widget">;
        T?: PdfString;
        Type?: PdfName<"Annot">;
        V?: PdfName<string> | PdfString;
    }[K],
): void
Type Parameters
- K extends
      | "Type"
      | "V"
      | "P"
      | "T"
      | "F"
      | "Subtype"
      | "FT"
      | "DV"
      | "DA"
      | "AS"
      | "Kids"
      | "Rect"
      | "Ff"
      | "BS"
      | "MK"
Parameters
- key: K | PdfName<K>
- value: {
      AS?: PdfName<string>;
      BS?: PdfDictionary<PdfDictionaryEntries>;
      DA?: PdfString;
      DV?: PdfName<string> | PdfString;
      F?: PdfNumber;
      Ff?: PdfNumber;
      FT: PdfName<PdfFieldType>;
      Kids?: PdfArray<PdfObjectReference>;
      MK?: PdfDictionary<PdfDictionaryEntries>;
      P?: PdfObjectReference;
      Rect?: PdfArray<PdfNumber>;
      Subtype?: PdfName<"Widget">;
      T?: PdfString;
      Type?: PdfName<"Annot">;
      V?: PdfName<string> | PdfString;
  }[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

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

Class PdfAcroFormField

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfAcroFormField

Properties

Optional Readonlycontainer

Optionalform

innerTokens

Protectedmodified

Optionalparent

OptionalpostTokens

OptionalpreTokens

Accessors

checked

Returns boolean

Parameters

Returns void

defaultValue

Returns string

Parameters

Returns void

fieldType

Returns PdfFieldType | null

Parameters

Returns void

flags

Returns number

Parameters

Returns void

font

Parameters

Returns void

fontName

Returns string | null

Parameters

Returns void

fontSize

Returns number | null

Parameters

Returns void

isWidget

Returns boolean

Parameters

Returns void

multiline

Returns boolean

Parameters

Returns void

name

Returns string

Parameters

Returns void

objectType

Returns string

parentRef

Returns PdfObjectReference | null

Parameters

Returns void

password

Returns boolean

Parameters

Returns void

readOnly

Returns boolean

Parameters

Returns void

rect

Returns number[] | null

Parameters

Returns void

required

Returns boolean

Parameters

`Optional` `Readonly`container

`Optional`form

`Protected`modified

`Optional`parent

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize