Interface: FlowCheckBoxOptions
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 |
|---|---|---|---|
actions? | FieldActions | JavaScript actions attached to this field's /AA dictionary. Each action value is raw PDF JavaScript source code. | CheckBoxOptions.actions |
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 |
borderWidth? | number | Annotation or field border width in PDF points. | CheckBoxOptions.borderWidth |
checked? | boolean | Initial checkbox checked state. | CheckBoxOptions.checked |
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 |
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 |
height | number | Height in PDF points. | CheckBoxOptions.height |
margin? | FlowMarginShorthand | CSS-like margin shorthand in PDF points. | FlowBlockSpacingOptions.margin |
marginBottom? | number | Bottom margin in PDF points. | FlowBlockSpacingOptions.marginBottom |
marginLeft? | number | Left margin in PDF points. | FlowBlockSpacingOptions.marginLeft |
marginRight? | number | Right margin in PDF points. | FlowBlockSpacingOptions.marginRight |
marginTop? | number | Top margin in PDF points. | FlowBlockSpacingOptions.marginTop |
readOnly? | boolean | Whether the form field is read-only. | CheckBoxOptions.readOnly |
required? | boolean | Whether the form field is required. | CheckBoxOptions.required |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | CheckBoxOptions.structure |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | CheckBoxOptions.tag |
width? | number | Width override in PDF points. | - |
x? | number | Horizontal position override in PDF points. | - |
y? | number | Vertical position override in PDF points. | - |