Appearance
a11ydocs / FlowCheckBoxOptions
Interface: FlowCheckBoxOptions
Defined in: src/types.ts:1253
Options for placing a checkbox form field through the flow layout API.
Extends
Omit<CheckBoxOptions,"x"|"y"|"width">.FlowBlockSpacingOptions
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
actions? | FieldActions | JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code. | CheckBoxOptions.actions | 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) | CheckBoxOptions.appearance | src/types.ts:2664 |
borderWidth? | number | Annotation or field border width in PDF points. | CheckBoxOptions.borderWidth | src/types.ts:2645 |
checked? | boolean | Initial checkbox checked state. | CheckBoxOptions.checked | 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. | CheckBoxOptions.description | 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). | CheckBoxOptions.encrypt | src/types.ts:2657 |
height | number | Height in PDF points. | CheckBoxOptions.height | src/types.ts:2643 |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin | src/types.ts:1137 |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom | src/types.ts:1143 |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft | src/types.ts:1145 |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight | src/types.ts:1141 |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop | src/types.ts:1139 |
readOnly? | boolean | Whether the form field is read-only. | CheckBoxOptions.readOnly | src/types.ts:2649 |
required? | boolean | Whether the form field is required. | CheckBoxOptions.required | src/types.ts:2651 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | CheckBoxOptions.structure | src/types.ts:2673 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | CheckBoxOptions.tag | src/types.ts:2671 |
width? | number | Width override in PDF points. | - | src/types.ts:1260 |
x? | number | Horizontal position override in PDF points. | - | src/types.ts:1256 |
y? | number | Vertical position override in PDF points. | - | src/types.ts:1258 |