Appearance
a11ydocs / CheckBoxOptions
Interface: CheckBoxOptions
Defined in: src/types.ts:2629
Options for creating a checkbox form field widget.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
actions? | FieldActions | JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code. | src/types.ts:2669 |
appearance? | | string | { down?: string; normal?: string; rollover?: string; } | Custom appearance stream for the checkbox. Can be a raw PDF content stream string (used for all states), or an object with optional normal (/N), down (/D), and rollover (/R) appearance strings. Example string: "1 0 0 0 0 1 2 10 14 6 re s" (a check mark at any size) | src/types.ts:2664 |
borderWidth? | number | Annotation or field border width in PDF points. | src/types.ts:2645 |
checked? | boolean | Initial checkbox checked state. | src/types.ts:2647 |
description? | string | Field description, emitted as /TU (the field's user-facing name). Assistive technology reads it as the field's accessible name, and it satisfies the "form fields have a description" accessibility check. | src/types.ts:2635 |
encrypt? | boolean | Whether the field value follows document encryption. When false, the field value is not encrypted (useful for searchable fields). Defaults to true (follow document encryption). | src/types.ts:2657 |
height | number | Height in PDF points. | src/types.ts:2643 |
readOnly? | boolean | Whether the form field is read-only. | src/types.ts:2649 |
required? | boolean | Whether the form field is required. | src/types.ts:2651 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2673 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | src/types.ts:2671 |
width | number | Width in PDF points. | src/types.ts:2641 |
x | number | Horizontal position in PDF points. | src/types.ts:2637 |
y | number | Vertical position in PDF points. | src/types.ts:2639 |