Appearance
zeropdf / TextFieldOptions
Interface: TextFieldOptions
Defined in: src/types.ts:2512
Options for creating a text 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:2565 |
appearance? | string | Custom appearance stream content. When provided, this raw PDF content stream is used instead of the auto-generated appearance for the /N (normal) appearance state. Example: "1 0 0 rg 0 0 16 16 re f" | src/types.ts:2560 |
borderWidth? | number | Annotation or field border width in PDF points. | src/types.ts:2536 |
color? | ColorInput | Color used for drawing, text, or highlighting. | src/types.ts:2534 |
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:2518 |
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:2553 |
font? | FontName | Font used to render text. | src/types.ts:2530 |
fontSize? | number | Font size in PDF points. | src/types.ts:2532 |
height | number | Height in PDF points. | src/types.ts:2526 |
multiline? | boolean | Whether the text field accepts multiple lines. | src/types.ts:2542 |
readOnly? | boolean | Whether the form field is read-only. | src/types.ts:2538 |
required? | boolean | Whether the form field is required. | src/types.ts:2540 |
richValue? | string | Rich text value (XML string in XFA rich text format). When set, emitted as /RV in the field dictionary. | src/types.ts:2547 |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | src/types.ts:2569 |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | src/types.ts:2567 |
value? | string | Current or default value for the option. | src/types.ts:2528 |
width | number | Width in PDF points. | src/types.ts:2524 |
x | number | Horizontal position in PDF points. | src/types.ts:2520 |
y | number | Vertical position in PDF points. | src/types.ts:2522 |