API reference / Common / Engine types / TextFormField

Interface: TextFormField

w:ffData — a form field's state: what it is called, how it behaves, and what the user has put in it.

Every other opaque payload a field carries is preservation, kept because we cannot read it. This one is read, because nothing else holds it. FORMCHECKBOX and FORMDROPDOWN are result-less — begin + instrText + end, with no separate and so no result region — so the checked flag, the list entries and the current selection live nowhere but here. Without it the form cannot be painted, let alone filled in.

FORMTEXT is the exception that keeps the rule: it does have a result region, holding the entered text, and what lives here is the rules that text is entered under.

Properties

Property	Description
name string | null	w:name — how a macro or a data binding addresses this field.
label number | null	w:label.
tabIndex number | null	w:tabIndex — where the field sits in the form's tab order.
enabled boolean	w:enabled — whether the field can be filled in. Defaults to enabled, which is why the absent element means true.
calculateOnExit boolean	w:calcOnExit — recalculate the document's fields when this one is left.
helpText string | null	w:helpText — shown on request while the field has focus.
statusText string | null	w:statusText — shown in the status bar while the field has focus.
entryMacro string | null	w:entryMacro — run when the field is entered.
exitMacro string | null	w:exitMacro — run when the field is left.
kind TextFormFieldKind	Which of the three form fields this is, and its own state.