Class PdfFormFieldFlags

Field-specific Ff flag accessors for form fields. These are separate from annotation flags (F field). Extends PdfNumber so it can be stored directly in a PDF dictionary.

Hierarchy (View Summary)

PdfNumber
- PdfFormFieldFlags

Constructors

constructor

new PdfFormFieldFlags(
value?: number | PdfNumber | PdfFormFieldFlags,
): PdfFormFieldFlags
Parameters
- value: number | PdfNumber | PdfFormFieldFlags = 0
Returns PdfFormFieldFlags
Overrides PdfNumber.constructor
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:9

Properties

`Protected` `Optional`cachedTokens

cachedTokens?: PdfToken[]

Cached byte representation of the object, if available

decimalPlaces

decimalPlaces: number

`Protected`immutable

immutable: boolean = false

Indicates whether the object is immutable (cannot be modified)

isByteOffset

isByteOffset: boolean = false

`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

padTo

padTo: 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

Accessors

comb

get comb(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:130
set comb(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:133

combo

get combo(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:88
set combo(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:91

commitOnSelChange

get commitOnSelChange(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:137
set commitOnSelChange(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:140

doNotScroll

get doNotScroll(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:123
set doNotScroll(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:126

doNotSpellCheck

get doNotSpellCheck(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:116
set doNotSpellCheck(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:119

edit

get edit(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:95
set edit(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:98

flags

get flags(): number
Returns number
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:16
set flags(v: number | PdfFormFieldFlags): void
Parameters
- v: number | PdfFormFieldFlags
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:20

isTrailingDelimited

get isTrailingDelimited(): boolean
Returns true if this object's serialized form ends with a self-delimiting character (e.g., ), >, ], >>). Such objects do not require trailing whitespace before the next token.

Returns boolean
Inherited from PdfNumber.isTrailingDelimited
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:30

multiline

get multiline(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:53
set multiline(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:56

multiSelect

get multiSelect(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:109
set multiSelect(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:112

noExport

get noExport(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:46
set noExport(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:49

noToggleToOff

get noToggleToOff(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:67
set noToggleToOff(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:70

objectType

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

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

password

get password(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:60
set password(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:63

pushButton

get pushButton(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:81
set pushButton(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:84

radio

get radio(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:74
set radio(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:77

readOnly

get readOnly(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:32
set readOnly(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:35

ref

get ref(): Ref<number>
Returns Ref<number>
Inherited from PdfNumber.ref
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:54

required

get required(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:39
set required(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:42

sort

get sort(): boolean
Returns boolean
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:102
set sort(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in packages/pdf-lite/src/acroform/fields/pdf-form-field-flags.ts:105

value

get value(): number
Returns number
Inherited from PdfNumber.value
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:58
set value(value: number): void
Parameters
- value: number
Returns void
Inherited from PdfNumber.value
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:62

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

clone

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

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

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 PdfNumber.cloneImpl
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:83

equals

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

isImmutable

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

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

isModified

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

Returns boolean
Inherited from PdfNumber.isModified
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:97

onChange

onChange(callback: (value: number) => void): void
Parameters
- callback: (value: number) => void
Returns void
Inherited from PdfNumber.onChange
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:66

setImmutable

setImmutable(immutable?: boolean): void
Sets the immutable state of the object
Parameters
- immutable: boolean = true
Returns void
Inherited from PdfNumber.setImmutable
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:50

setModified

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

toBase64

toBase64(): string
Serializes the document to a Base64-encoded string.

Returns string
A promise that resolves to the PDF document as a Base64 string
Inherited from PdfNumber.toBase64
- Defined in packages/pdf-lite/src/core/objects/pdf-object.ts:156

toBytes

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

`Protected`tokenize

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

Returns PdfNumberToken[]
Inherited from PdfNumber.tokenize
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:79

toString

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

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

toToken

toToken(): PdfNumberToken
Returns PdfNumberToken
Inherited from PdfNumber.toToken
- Defined in packages/pdf-lite/src/core/objects/pdf-number.ts:70

toTokens

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

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

Class PdfFormFieldFlags

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PdfFormFieldFlags

Properties

Protected OptionalcachedTokens

decimalPlaces

Protectedimmutable

isByteOffset

Protectedmodified

padTo

OptionalpostTokens

OptionalpreTokens

Accessors

comb

Returns boolean

Parameters

Returns void

combo

Returns boolean

Parameters

Returns void

commitOnSelChange

Returns boolean

Parameters

Returns void

doNotScroll

Returns boolean

Parameters

Returns void

doNotSpellCheck

Returns boolean

Parameters

Returns void

edit

Returns boolean

Parameters

Returns void

flags

Returns number

Parameters

Returns void

isTrailingDelimited

Returns boolean

multiline

Returns boolean

Parameters

Returns void

multiSelect

Returns boolean

Parameters

Returns void

noExport

Returns boolean

Parameters

Returns void

noToggleToOff

Returns boolean

Parameters

Returns void

objectType

Returns string

password

Returns boolean

Parameters

Returns void

pushButton

Returns boolean

Parameters

Returns void

radio

Returns boolean

Parameters

`Protected` `Optional`cachedTokens

`Protected`immutable

`Protected`modified

`Optional`postTokens

`Optional`preTokens

`Protected`tokenize