Appearance
zeropdf / ChoiceFieldOptions
Interface: ChoiceFieldOptions
Defined in: src/types.ts:2630
Options for creating a list box or combo box form field.
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:2684 |
appearance? | string | Custom appearance stream content for the choice field. Example: "1 0 0 rg 0 0 100 20 re f" | src/types.ts:2679 |
borderWidth? | number | Annotation or field border width in PDF points. | src/types.ts:2656 |
color? | ColorInput | Color used for drawing, text, or highlighting. | src/types.ts:2654 |
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:2636 |
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. | src/types.ts:2668 |
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:2674 |
font? | FontName | Font used to render text. | src/types.ts:2650 |
fontSize? | number | Font size in PDF points. | src/types.ts:2652 |
height | number | Height in PDF points. | src/types.ts:2644 |
mode? | ChoiceFieldMode | Choice field display mode. | src/types.ts:2662 |
options | string[] | Options that control this item. | src/types.ts:2646 |
readOnly? | boolean | Whether the form field is read-only. | src/types.ts:2658 |
required? | boolean | Whether the form field is required. | src/types.ts:2660 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2688 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | src/types.ts:2686 |
value? | string | Current or default value for the option. | src/types.ts:2648 |
width | number | Width in PDF points. | src/types.ts:2642 |
x | number | Horizontal position in PDF points. | src/types.ts:2638 |
y | number | Vertical position in PDF points. | src/types.ts:2640 |