PDF Text Box¶
Places a fillable form field in the exported PDF.
PDF components · element type pdf-text-box · binds through text templates in the initial value
Related: Text · Export Formats
Options¶
Configure the field with these options:
| Option | Description |
|---|---|
| Name | Required. Identifies the field inside the PDF. Give each field on a report a distinct name, since this is what a PDF viewer and any downstream tooling use to read the value back |
| Text | The value the field starts with. Accepts text template syntax, so it can be constant text, a data binding (e.g., {$data.customerName}), or a parameter (e.g., {$params.period}) |
| Tooltip | Hint shown when the recipient hovers over the field. Also accepts text template syntax |
| Mapping Name | An alternative name used when field values are exported or imported. Leave empty unless you are matching an existing form definition |
| Multiline | Allows the field to hold more than one line of text |
| Required | Marks the field as required, so PDF viewers flag it when the form is submitted incomplete |
| Scrollable | Lets the recipient keep typing past the visible height of the field |
| Readonly | The field is visible but cannot be edited |
| Flatten | Renders the field as ordinary page content. The value stays visible but is no longer fillable |
| Spellcheck | Enables the PDF viewer's spell checker inside the field |
| Max Length | Maximum number of characters the field accepts |
Styling¶
Appearance options live in the Styling section of the properties panel:
| Option | Description |
|---|---|
| Font Family | Defaults to Helvetica |
| Font Size | In points |
| Bold, Italic | Font weight and style |
| Border Width | In points |
| Border Color | Field outline |
| Fore Color | Colour of the text the recipient types |
| Back Color | Fill behind the field |
| Text Alignment | left, center, or right |
Fonts. PDF form fields can only use fonts that are embedded or built into the PDF standard. Helvetica, Times Roman, and Courier are always available, and common aliases map onto them — Arial and sans-serif become Helvetica, Times New Roman and serif become Times Roman, Courier New and monospace become Courier. Any other family needs a matching font file installed in the custom font directory; if none is found, the field falls back to Helvetica.
Colours. Hex (#fff, #ffffff, #ffffffcc) and rgb() / rgba() values are both accepted. Use transparent, or an alpha of zero, to leave the border or background unpainted.
Alignment. PDF form fields have no justified alignment. If a theme supplies justify, the field is rendered left-aligned.
Notes¶
- You will find it under the PDF group in the component ribbon
- Name is required and must be meaningful — it is the handle anything reading the completed form will use
- Turn on Flatten when you want the value to appear in the final document but not stay editable, for example on an archived copy
- Fillable fields are a PDF feature. The other export formats are produced by converting the rendered PDF, so do not rely on fields remaining interactive outside PDF output
- This component does not require the Apryse module — form fields are produced by the built-in PDF engine, and instances licensed for Apryse simply use that engine instead
- A field starts at 150 × 32 px; resize it on the canvas to match the space the recipient needs