modern-pdf-lib

---

modern-pdf-lib / PdfCheckboxField

Class: PdfCheckboxField

Defined in: src/form/fields/checkboxField.ts:28

A PDF checkbox form field (/FT /Btn).

The value is either the "on" name (typically "Yes") or "/Off". The /AS (appearance state) entry controls which appearance is shown.

Extends

• PdfField

Constructors

Constructor

new PdfCheckboxField(name, dict, widgetDict, parentNames?): PdfCheckboxField

Defined in: src/form/pdfField.ts:175

Parameters

name

string

dict

PdfDict

widgetDict

PdfDict

parentNames?

string[] = []

Returns

PdfCheckboxField

Inherited from

PdfField.constructor

Properties

dict

protected readonly dict: PdfDict

Defined in: src/form/pdfField.ts:164

The underlying field dictionary (may contain both field and widget entries for simple one-widget fields).

Inherited from

PdfField.dict

---

fieldType

readonly fieldType: FieldType = 'checkbox'

Defined in: src/form/fields/checkboxField.ts:29

Discriminator for the concrete field type.

Overrides

PdfField.fieldType

---

name

readonly name: string

Defined in: src/form/pdfField.ts:158

The fully-qualified field name.

Inherited from

PdfField.name

---

parentNames

protected readonly parentNames: string[]

Defined in: src/form/pdfField.ts:173

Parent field dictionary chain for building full names.

Inherited from

PdfField.parentNames

---

widgetDict

protected readonly widgetDict: PdfDict

Defined in: src/form/pdfField.ts:170

The widget annotation dictionary. For merged field+widget dicts, this is the same object as dict.

Inherited from

PdfField.widgetDict

Methods

addToPage()

addToPage(page): void

Defined in: src/form/pdfField.ts:309

Add this field's widget annotation to a page.

Ensures the widget dict has /Type /Annot and /Subtype /Widget, then adds it to the page's annotation list so it appears in the rendered PDF.

Parameters

page

WidgetAnnotationHost

A page that implements WidgetAnnotationHost.

Returns

void

Inherited from

PdfField.addToPage

---

check()

check(): void

Defined in: src/form/fields/checkboxField.ts:51

Check the checkbox (set to the "on" value).

Returns

void

---

disableExporting()

disableExporting(): void

Defined in: src/form/pdfField.ts:271

Disable exporting this field (set the NoExport flag).

Returns

void

Inherited from

PdfField.disableExporting

---

enableExporting()

enableExporting(): void

Defined in: src/form/pdfField.ts:266

Enable exporting this field (clear the NoExport flag).

Returns

void

Inherited from

PdfField.enableExporting

---

generateAppearance()

generateAppearance(): PdfStream

Defined in: src/form/fields/checkboxField.ts:133

Generate the appearance stream for this checkbox.

Returns

PdfStream

Overrides

PdfField.generateAppearance

---

getFieldFlags()

protected getFieldFlags(): number

Defined in: src/form/pdfField.ts:211

Get the raw /Ff (field flags) integer value.

Returns

number

Inherited from

PdfField.getFieldFlags

---

getFullName()

getFullName(): string

Defined in: src/form/pdfField.ts:201

Get the fully qualified field name (Parent.Child.Name format). Per PDF spec SS12.7.3.2, the full name is formed by concatenating ancestor /T values with periods.

Returns

string

Inherited from

PdfField.getFullName

---

getName()

getName(): string

Defined in: src/form/pdfField.ts:192

Get the partial field name (/T entry).

Returns

string

Inherited from

PdfField.getName

---

getOnValue()

getOnValue(): string

Defined in: src/form/fields/checkboxField.ts:80

Get the "on" value name for this checkbox.

Examines the /AP /N dictionary for a key that is not "/Off". Falls back to "Yes" if no appearance dictionary is found.

Returns

string

---

getRect()

getRect(): [number, number, number, number]

Defined in: src/form/pdfField.ts:283

Get the field's widget rectangle as [x1, y1, x2, y2]. The /Rect entry comes from the widget annotation dictionary.

Returns

[number, number, number, number]

Inherited from

PdfField.getRect

---

getValue()

getValue(): boolean

Defined in: src/form/fields/checkboxField.ts:106

Get the value: "Yes"/"Off" as boolean for convenience.

Returns

boolean

Overrides

PdfField.getValue

---

hasFlag()

protected hasFlag(flag): boolean

Defined in: src/form/pdfField.ts:221

Check if a specific flag bit is set.

Parameters

flag

number

Returns

boolean

Inherited from

PdfField.hasFlag

---

isChecked()

isChecked(): boolean

Defined in: src/form/fields/checkboxField.ts:40

Check whether the checkbox is currently checked.

The checkbox is checked when /V or /AS is not "/Off".

Returns

boolean

---

isExported()

isExported(): boolean

Defined in: src/form/pdfField.ts:261

Whether the field is exported (inverse of NoExport flag).

Returns

boolean

Inherited from

PdfField.isExported

---

isNoExport()

isNoExport(): boolean

Defined in: src/form/pdfField.ts:256

Whether the field should not be exported.

Returns

boolean

Inherited from

PdfField.isNoExport

---

isReadOnly()

isReadOnly(): boolean

Defined in: src/form/pdfField.ts:236

Whether the field is read-only.

Returns

boolean

Inherited from

PdfField.isReadOnly

---

isRequired()

isRequired(): boolean

Defined in: src/form/pdfField.ts:246

Whether the field is required.

Returns

boolean

Inherited from

PdfField.isRequired

---

setFieldFlags()

protected setFieldFlags(flags): void

Defined in: src/form/pdfField.ts:216

Set the raw /Ff (field flags) integer value.

Parameters

flags

number

Returns

void

Inherited from

PdfField.setFieldFlags

---

setFlag()

protected setFlag(flag, on): void

Defined in: src/form/pdfField.ts:226

Set or clear a specific flag bit.

Parameters

flag

number

on

boolean

Returns

void

Inherited from

PdfField.setFlag

---

setReadOnly()

setReadOnly(readOnly): void

Defined in: src/form/pdfField.ts:241

Set the read-only flag.

Parameters

readOnly

boolean

Returns

void

Inherited from

PdfField.setReadOnly

---

setRequired()

setRequired(required): void

Defined in: src/form/pdfField.ts:251

Set the required flag.

Parameters

required

boolean

Returns

void

Inherited from

PdfField.setRequired

---

setValue()

setValue(value): void

Defined in: src/form/fields/checkboxField.ts:111

Set the value as boolean.

Parameters

value

string | boolean | string[]

Returns

void

Overrides

PdfField.setValue

---

toggle()

toggle(): void

Defined in: src/form/fields/checkboxField.ts:66

Toggle the checkbox.

Returns

void

---

uncheck()

uncheck(): void

Defined in: src/form/fields/checkboxField.ts:59

Uncheck the checkbox (set to /Off).

Returns

void