Interface: FlowTextFieldOptions
Options for placing a text form field through the flow layout API.
Extends
Omit<TextFieldOptions,"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. | TextFieldOptions.actions |
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" | TextFieldOptions.appearance |
borderWidth? | number | Annotation or field border width in PDF points. | TextFieldOptions.borderWidth |
color? | ColorInput | Color used for drawing, text, or highlighting. | TextFieldOptions.color |
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. | TextFieldOptions.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). | TextFieldOptions.encrypt |
font? | FontName | Font used to render text. | TextFieldOptions.font |
fontSize? | number | Font size in PDF points. | TextFieldOptions.fontSize |
height | number | Height in PDF points. | TextFieldOptions.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 |
multiline? | boolean | Whether the text field accepts multiple lines. | TextFieldOptions.multiline |
readOnly? | boolean | Whether the form field is read-only. | TextFieldOptions.readOnly |
required? | boolean | Whether the form field is required. | TextFieldOptions.required |
richValue? | string | Rich text value (XML string in XFA rich text format). When set, emitted as /RV in the field dictionary. | TextFieldOptions.richValue |
structure? | PdfStructureOptions | Additional structure metadata for tagged PDF output. | TextFieldOptions.structure |
tag? | "Annot" | "Artifact" | Structure tag used for tagged PDF output. | TextFieldOptions.tag |
value? | string | Current or default value for the option. | TextFieldOptions.value |
width? | number | Width override in PDF points. | - |
x? | number | Horizontal position override in PDF points. | - |
y? | number | Vertical position override in PDF points. | - |