Class PdfTextFormField

Text form field subtype.

Hierarchy (View Summary)

PdfFormField
- PdfTextFormField

Index

Constructors

Properties

_appearanceStream? _appearanceStreamYes? content defaultGenerateAppearance encryptable? form? generationNumber immutable modified objectNumber offset orderIndex? postTokens? preTokens? MAX_ORDER_INDEX

Constructors

constructor

new PdfTextFormField(
    options?: {
        form?: FormContext<PdfFormField>;
        other?: PdfIndirectObject<PdfObject>;
        parent?: PdfFormField;
    },
): PdfTextFormField
Parameters
- Optionaloptions: {
      form?: FormContext<PdfFormField>;
      other?: PdfIndirectObject<PdfObject>;
      parent?: PdfFormField;
  }
Returns PdfTextFormField
Inherited from PdfFormField.constructor
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:31

Properties

`Protected` `Optional`_appearanceStream

_appearanceStream?: PdfAppearanceStream

`Protected` `Optional`_appearanceStreamYes

_appearanceStreamYes?: PdfAppearanceStream

content

content: PdfDictionary

defaultGenerateAppearance

defaultGenerateAppearance: boolean = true

`Optional`encryptable

encryptable?: boolean

`Optional`form

form?: FormContext<PdfFormField>

generationNumber

generationNumber: number

`Protected`immutable

immutable: boolean = false

Indicates whether the object is immutable (cannot be modified)

`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

objectNumber

objectNumber: number

offset

offset: Ref<number>

`Optional`orderIndex

orderIndex?: number

`Optional`postTokens

postTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Optional`preTokens

preTokens?: PdfToken[]

Optional tokens to prepend or append during serialization

`Static` `Readonly`MAX_ORDER_INDEX

MAX_ORDER_INDEX: 2147483647

Accessors

annotationFlags

get annotationFlags(): number
Returns number
Inherited from PdfFormField.annotationFlags
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:74
set annotationFlags(flags: number): void
Parameters
- flags: number
Returns void
Inherited from PdfFormField.annotationFlags
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:78

appearanceState

get appearanceState(): string | null
Returns string | null
Inherited from PdfFormField.appearanceState
- Defined in packages/pdf-lite/src/annotations/pdf-widget-annotation.ts:30
set appearanceState(state: string | null): void
Parameters
- state: string | null
Returns void
Inherited from PdfFormField.appearanceState
- Defined in packages/pdf-lite/src/annotations/pdf-widget-annotation.ts:34

appearanceStreamDict

get appearanceStreamDict(): PdfAppearanceStreamDictionary | null
Returns PdfAppearanceStreamDictionary | null
Inherited from PdfFormField.appearanceStreamDict
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:138
set appearanceStreamDict(dict: PdfAppearanceStreamDictionary | null): void
Parameters
- dict: PdfAppearanceStreamDictionary | null
Returns void
Inherited from PdfFormField.appearanceStreamDict
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:144

checked

get checked(): boolean
Returns boolean
Inherited from PdfFormField.checked
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:207
set checked(_isChecked: boolean): void
Parameters
- _isChecked: boolean
Returns void
Inherited from PdfFormField.checked
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:211

children

get children(): PdfFormField[]
Returns PdfFormField[]
Inherited from PdfFormField.children
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:78
set children(fields: PdfFormField[]): void
Parameters
- fields: PdfFormField[]
Returns void
Inherited from PdfFormField.children
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:83

comb

get comb(): boolean
Returns boolean
Inherited from PdfFormField.comb
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:321

combField

get combField(): boolean
Returns boolean
Inherited from PdfFormField.combField
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:325
set combField(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.combField
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:328

combo

get combo(): boolean
Returns boolean
Inherited from PdfFormField.combo
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:332
set combo(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.combo
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:335

commitOnSelChange

get commitOnSelChange(): boolean
Returns boolean
Inherited from PdfFormField.commitOnSelChange
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:402
set commitOnSelChange(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.commitOnSelChange
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:406

defaultAppearance

get defaultAppearance(): string | null
Returns string | null
Inherited from PdfFormField.defaultAppearance
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:422
set defaultAppearance(da: string): void
Parameters
- da: string
Returns void
Inherited from PdfFormField.defaultAppearance
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:431

defaultValue

get defaultValue(): string
Returns string
Inherited from PdfFormField.defaultValue
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:142
set defaultValue(val: string): void
Parameters
- val: string
Returns void
Inherited from PdfFormField.defaultValue
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:149

doNotScroll

get doNotScroll(): boolean
Returns boolean
Inherited from PdfFormField.doNotScroll
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:395
set doNotScroll(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.doNotScroll
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:398

doNotSpellCheck

get doNotSpellCheck(): boolean
Returns boolean
Inherited from PdfFormField.doNotSpellCheck
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:388
set doNotSpellCheck(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.doNotSpellCheck
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:391

edit

get edit(): boolean
Returns boolean
Inherited from PdfFormField.edit
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:367
set edit(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.edit
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:370

encodingMap

get encodingMap(): Map<number, string> | undefined
Returns Map<number, string> | undefined
Inherited from PdfFormField.encodingMap
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:97

fieldType

get fieldType(): "Text" | "Button" | "Choice" | "Signature" | null
Returns "Text" | "Button" | "Choice" | "Signature" | null
Inherited from PdfFormField.fieldType
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:103
set fieldType(type: "Text" | "Button" | "Choice" | "Signature" | null): void
Parameters
- type: "Text" | "Button" | "Choice" | "Signature" | null
Returns void
Inherited from PdfFormField.fieldType
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:121

flags

get flags(): PdfFormFieldFlags
Returns PdfFormFieldFlags
Inherited from PdfFormField.flags
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:278
set flags(v: PdfFormFieldFlags): void
Parameters
- v: PdfFormFieldFlags
Returns void
Inherited from PdfFormField.flags
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:288

font

set font(font: PdfFont | null): void
Parameters
- font: PdfFont | null
Returns void
Inherited from PdfFormField.font
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:256

fontName

get fontName(): string | null
Returns string | null
Inherited from PdfFormField.fontName
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:234
set fontName(fontName: string): void
Parameters
- fontName: string
Returns void
Inherited from PdfFormField.fontName
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:240

get fontSize(): number | null
Returns number | null
Inherited from PdfFormField.fontSize
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:215
set fontSize(size: number): void
Parameters
- size: number
Returns void
Inherited from PdfFormField.fontSize
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:221

hidden

get hidden(): boolean
Returns boolean
Inherited from PdfFormField.hidden
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:90
set hidden(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PdfFormField.hidden
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:94

invisible

get invisible(): boolean
Returns boolean
Inherited from PdfFormField.invisible
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:82
set invisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PdfFormField.invisible
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:86

isWidget

get isWidget(): boolean
Returns boolean
Inherited from PdfFormField.isWidget
- Defined in packages/pdf-lite/src/annotations/pdf-widget-annotation.ts:14
set isWidget(isWidget: boolean): void
Parameters
- isWidget: boolean
Returns void
Inherited from PdfFormField.isWidget
- Defined in packages/pdf-lite/src/annotations/pdf-widget-annotation.ts:20

kids

get kids(): PdfObjectReference[]
Returns PdfObjectReference[]
Inherited from PdfFormField.kids
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:447
set kids(kids: PdfObjectReference[]): void
Parameters
- kids: PdfObjectReference[]
Returns void
Inherited from PdfFormField.kids
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:455

locked

get locked(): boolean
Returns boolean
Inherited from PdfFormField.locked
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:130
set locked(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PdfFormField.locked
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:134

maxLen

get maxLen(): number | null
Returns number | null
Inherited from PdfFormField.maxLen
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:435
set maxLen(maxLen: number | null): void
Parameters
- maxLen: number | null
Returns void
Inherited from PdfFormField.maxLen
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:439

multiline

get multiline(): boolean
Returns boolean
Inherited from PdfFormField.multiline
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:307
set multiline(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.multiline
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:310

multiSelect

get multiSelect(): boolean
Returns boolean
Inherited from PdfFormField.multiSelect
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:381
set multiSelect(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.multiSelect
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:384

name

get name(): string
Returns string
Inherited from PdfFormField.name
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:129
set name(name: string): void
Parameters
- name: string
Returns void
Inherited from PdfFormField.name
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:138

noExport

get noExport(): boolean
Returns boolean
Inherited from PdfFormField.noExport
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:353
set noExport(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.noExport
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:356

noRotate

get noRotate(): boolean
Returns boolean
Inherited from PdfFormField.noRotate
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:114
set noRotate(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PdfFormField.noRotate
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:118

noToggleToOff

get noToggleToOff(): boolean
Returns boolean
Inherited from PdfFormField.noToggleToOff
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:346
set noToggleToOff(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.noToggleToOff
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:349

noView

get noView(): boolean
Returns boolean
Inherited from PdfFormField.noView
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:122
set noView(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PdfFormField.noView
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:126

noZoom

get noZoom(): boolean
Returns boolean
Inherited from PdfSignatureFormField.noZoom
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:106
set noZoom(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PdfSignatureFormField.noZoom
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:110

objectType

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

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

parent

get parent(): PdfFormField | undefined
Returns PdfFormField | undefined
Inherited from PdfFormField.parent
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:43
set parent(field: PdfFormField | undefined): void
Parameters
- field: PdfFormField | undefined
Returns void
Inherited from PdfFormField.parent
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:57

parentRef

get parentRef(): PdfObjectReference | null
Returns PdfObjectReference | null
Inherited from PdfFormField.parentRef
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:152
set parentRef(ref: PdfObjectReference | null): void
Parameters
- ref: PdfObjectReference | null
Returns void
Inherited from PdfFormField.parentRef
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:157

password

get password(): boolean
Returns boolean
Inherited from PdfFormField.password
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:314
set password(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.password
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:317

print

get print(): boolean
Returns boolean
Inherited from PdfSignatureFormField.print
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:98
set print(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PdfSignatureFormField.print
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:102

pushButton

get pushButton(): boolean
Returns boolean
Inherited from PdfFormField.pushButton
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:360
set pushButton(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.pushButton
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:363

quadding

get quadding(): number
Returns number
Inherited from PdfFormField.quadding
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:410
set quadding(q: number): void
Parameters
- q: number
Returns void
Inherited from PdfFormField.quadding
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:418

radio

get radio(): boolean
Returns boolean
Inherited from PdfFormField.radio
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:339
set radio(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.radio
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:342

readOnly

get readOnly(): boolean
Returns boolean
Inherited from PdfSignatureFormField.readOnly
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:292
set readOnly(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfSignatureFormField.readOnly
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:296

rect

get rect(): [number, number, number, number] | null
Returns [number, number, number, number] | null
Inherited from PdfFormField.rect
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:52
set rect(rect: [number, number, number, number] | null): void
Parameters
- rect: [number, number, number, number] | null
Returns void
Inherited from PdfFormField.rect
- Defined in packages/pdf-lite/src/annotations/pdf-annotation.ts:63

reference

get reference(): PdfObjectReference
Returns PdfObjectReference
Inherited from PdfFormField.reference
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:56

required

get required(): boolean
Returns boolean
Inherited from PdfFormField.required
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:300
set required(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.required
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:303

siblings

get siblings(): PdfFormField[]
Returns PdfFormField[]
Inherited from PdfFormField.siblings
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:93

sort

get sort(): boolean
Returns boolean
Inherited from PdfFormField.sort
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:374
set sort(v: boolean): void
Parameters
- v: boolean
Returns void
Inherited from PdfFormField.sort
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:377

value

get value(): string
Returns string
Inherited from PdfFormField.value
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:153
set value(val: string | PdfString): void
Parameters
- val: string | PdfString
Returns void
Inherited from PdfFormField.value
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:167

Methods

`Protected`_storeValue

_storeValue(
val: string | PdfString,
fieldParent: PdfFormField | undefined,
): boolean
Writes the value to the dictionary. Returns true if appearance generation should proceed, false to skip it (e.g. when value was cleared). Override in subclasses to change the stored representation.
Parameters
- val: string | PdfString
- fieldParent: PdfFormField | undefined
Returns boolean
Inherited from PdfFormField._storeValue
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:193

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 PdfFormField.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 PdfFormField.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 PdfFormField.cloneImpl
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:133

copyFrom

copyFrom(other: PdfIndirectObject): void
Parameters
- other: PdfIndirectObject
Returns void
Inherited from PdfFormField.copyFrom
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:125

equals

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

generateAppearance

generateAppearance(
options?: { makeReadOnly?: boolean; textYOffset?: number },
): boolean
Parameters
- Optionaloptions: { makeReadOnly?: boolean; textYOffset?: number }
Returns boolean
Overrides PdfFormField.generateAppearance
- Defined in packages/pdf-lite/src/acroform/fields/pdf-text-form-field.ts:17

isImmutable

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

Returns boolean
Inherited from PdfFormField.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 PdfFormField.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:146

matchesReference

matchesReference(ref?: PdfObjectReference): boolean
Parameters
- Optionalref: PdfObjectReference
Returns boolean
Inherited from PdfFormField.matchesReference
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:104

order

order(): number
Returns number
Inherited from PdfFormField.order
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:142

setAppearanceReference

setAppearanceReference(
appearanceStreamRef: PdfObjectReference,
_appearanceStreamYesRef?: PdfObjectReference,
): void
Parameters
- appearanceStreamRef: PdfObjectReference
- Optional_appearanceStreamYesRef: PdfObjectReference
Returns void
Inherited from PdfFormField.setAppearanceReference
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:480

setImmutable

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

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 PdfFormField.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 PdfFormField.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 PdfFormField.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:114

toString

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

Returns string
Inherited from PdfFormField.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 PdfFormField.toTokens
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:44

`Protected`tryGenerateAppearance

tryGenerateAppearance(field: PdfFormField): void
Parameters
- field: PdfFormField
Returns void
Inherited from PdfFormField.tryGenerateAppearance
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:203

`Static`create

create(
    options: {
        form: FormContext<PdfFormField>;
        other: PdfIndirectObject;
        parent?: PdfFormField;
    },
): PdfFormField
Parameters
- options: {
      form: FormContext<PdfFormField>;
      other: PdfIndirectObject;
      parent?: PdfFormField;
  }
Returns PdfFormField
Inherited from PdfFormField.create
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:522

`Static`createPlaceholder

createPlaceholder<T extends PdfObject>(
    objectNumber?: number,
    generationNumber?: number,
    content?: T,
): PdfIndirectObject<T extends unknown ? PdfNull : T>
Type Parameters
- T extends PdfObject
Parameters
- OptionalobjectNumber: number
- OptionalgenerationNumber: number
- Optionalcontent: T
Returns PdfIndirectObject<T extends unknown ? PdfNull : T>
Inherited from PdfFormField.createPlaceholder
- Defined in packages/pdf-lite/src/core/objects/pdf-indirect-object.ts:87

`Static`registerFieldType

registerFieldType(
    ft: "Sig" | "Tx" | "Btn" | "Ch",
    ctor: new (
        options?: {
            form?: FormContext<PdfFormField>;
            other?: PdfIndirectObject<PdfObject>;
            parent?: PdfFormField;
        },
    ) => PdfFormField,
    options?: { fallback?: boolean },
): void
Parameters
- ft: "Sig" | "Tx" | "Btn" | "Ch"
- ctor: new (
      options?: {
          form?: FormContext<PdfFormField>;
          other?: PdfIndirectObject<PdfObject>;
          parent?: PdfFormField;
      },
  ) => PdfFormField
- Optionaloptions: { fallback?: boolean }
Returns void
Inherited from PdfFormField.registerFieldType
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field.ts:507

Class PdfTextFormField

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfTextFormField

Properties

Protected Optional_appearanceStream

Protected Optional_appearanceStreamYes

content

defaultGenerateAppearance

Optionalencryptable

Optionalform

generationNumber

Protectedimmutable

Protectedmodified

objectNumber

offset

OptionalorderIndex

OptionalpostTokens

OptionalpreTokens

Static ReadonlyMAX_ORDER_INDEX

Accessors

annotationFlags

Returns number

Parameters

Returns void

appearanceState

Returns string | null

Parameters

Returns void

appearanceStreamDict

Returns PdfAppearanceStreamDictionary | null

Parameters

Returns void

checked

Returns boolean

Parameters

Returns void

children

Returns PdfFormField[]

Parameters

Returns void

comb

Returns boolean

combField

Returns boolean

Parameters

Returns void

combo

Returns boolean

Parameters

Returns void

commitOnSelChange

Returns boolean

Parameters

Returns void

defaultAppearance

Returns string | null

Parameters

Returns void

defaultValue

Returns string

Parameters

Returns void

doNotScroll

Returns boolean

Parameters

Returns void

doNotSpellCheck

Returns boolean

Parameters

Returns void

edit

Returns boolean

`Protected` `Optional`_appearanceStream

`Protected` `Optional`_appearanceStreamYes

`Optional`encryptable

`Optional`form

`Protected`immutable

`Protected`modified

`Optional`orderIndex

`Optional`postTokens

`Optional`preTokens

`Static` `Readonly`MAX_ORDER_INDEX