FormElement

Source:

Type Definitions

ButtonFormElement

Properties:
Name Type Attributes Description
selected boolean Whether the button is selected.
options Array.<{value: string, label: string}> <optional>
 The available options for the button.
onState string <optional>
 The state when the button is on.
buttonFormField FormField <optional>
 The associated button form field.
Source:

ChoiceFormElement

Properties:
Name Type Description
options Array.<{value: string, label: string}> The available options.
selectedIndices Array.<number> The indices of selected options.
isEditable boolean Whether the field is editable.
Source:

FormElement

Properties:
Name Type Attributes Description
formField FormField <optional>
 The associated form field.
resettable boolean <optional>
 Whether the form element can be reset.
defaultValue any <optional>
 The default value of the form element.
exportValue any <optional>
 The value exported when the form is submitted.
highlightColor string <optional>
 The highlight color of the form element.
calculationOrderIndex number The calculation order index.
readOnly boolean Whether the form element is read-only.
required boolean Whether the form element is required.
noExport boolean Whether the form element should not be exported.
fieldName string <optional>
 The name of the form field.
fullyQualifiedFieldName string <optional>
 The fully qualified name of the form field.
formTypeName string The type name of the form.
maxLength number The maximum length of the form element.
doNotScroll boolean Whether scrolling is disabled.
isMultiline boolean Whether the form element is multiline.
Source:

SignatureFormElement

Properties:
Name Type Attributes Description
signatureInfo Object <optional>
 Information about the signature.
isSigned boolean Whether the field is signed.
Source:

TextFieldFormElement

Properties:
Name Type Attributes Description
value string The current value of the text field.
isPassword boolean Whether this is a password field.
fontSize number The font size.
fontName string <optional>
 The font name.
Source: