Appearance
a11ydocs / FlowChoiceFieldOptions
Interface: FlowChoiceFieldOptions
Defined in: src/types.ts:1266
Options for placing a choice form field through the flow layout API.
Extends
Omit<ChoiceFieldOptions,"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. | ChoiceFieldOptions.actions | src/types.ts:2738 |
appearance? | string | Custom appearance stream content for the choice field. Example: "1 0 0 rg 0 0 100 20 re f" | ChoiceFieldOptions.appearance | src/types.ts:2733 |
borderWidth? | number | Annotation or field border width in PDF points. | ChoiceFieldOptions.borderWidth | src/types.ts:2710 |
color? | ColorInput | Color used for drawing, text, or highlighting. | ChoiceFieldOptions.color | src/types.ts:2708 |
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. | ChoiceFieldOptions.description | src/types.ts:2690 |
editable? | boolean | When true, the combo box allows user to type custom values. When false (default), combo box is select-only. Has no effect on list boxes. | ChoiceFieldOptions.editable | src/types.ts:2722 |
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). | ChoiceFieldOptions.encrypt | src/types.ts:2728 |
font? | FontName | Font used to render text. | ChoiceFieldOptions.font | src/types.ts:2704 |
fontSize? | number | Font size in PDF points. | ChoiceFieldOptions.fontSize | src/types.ts:2706 |
height | number | Height in PDF points. | ChoiceFieldOptions.height | src/types.ts:2698 |
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 |
mode? | ChoiceFieldMode | Choice field display mode. | ChoiceFieldOptions.mode | src/types.ts:2716 |
options | string[] | Options that control this item. | ChoiceFieldOptions.options | src/types.ts:2700 |
readOnly? | boolean | Whether the form field is read-only. | ChoiceFieldOptions.readOnly | src/types.ts:2712 |
required? | boolean | Whether the form field is required. | ChoiceFieldOptions.required | src/types.ts:2714 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | ChoiceFieldOptions.structure | src/types.ts:2742 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | ChoiceFieldOptions.tag | src/types.ts:2740 |
value? | string | Current or default value for the option. | ChoiceFieldOptions.value | src/types.ts:2702 |
width? | number | Width override in PDF points. | - | src/types.ts:1273 |
x? | number | Horizontal position override in PDF points. | - | src/types.ts:1269 |
y? | number | Vertical position override in PDF points. | - | src/types.ts:1271 |