FormField

Source:

Members

(static, readonly) Type :string

The different types of form fields.
Type:
  • string
Properties:
Name Type Description
UNKNOWN string No form type known.
PUSH_BUTTON string Push button form field.
RADIO_BUTTON string Radio button form field.
CHECK_BOX string Check box form field.
TEXT string Text form field.
LIST_BOX string List box form field.
COMBO_BOX string Combo box form field.
SIGNATURE string Signature form field.
Source:

Type Definitions

ButtonFormField

Properties:
Name Type Description
isPushButton boolean Whether this is a push button.
isCheckBox boolean Whether this is a check box.
isRadioButton boolean Whether this is a radio button.
selectedAnnotationObjectNumbers Array.<number> The selected annotation object numbers.
options Array.<{value: string, label: string}> The available options for the button.
Source:

ChoiceFormField

Properties:
Name Type Attributes Description
options Array.<{value: string, label: string}> The available options.
selectedIndices Array.<number> The indices of selected options.
isMultiSelect boolean Whether multiple selections are allowed.
isCombo boolean Whether this is a combo box.
isEditable boolean Whether the field is editable.
topIndex number <optional>
 The top index of visible options.
Source:

FormField

Properties:
Name Type Attributes Description
type FormField.Type <optional>
 The type of the form field.
name string <optional>
 The name of the form field.
fullyQualifiedName string <optional>
 The fully qualified name of the form field.
mappingName string <optional>
 The mapping name used when exporting form field data.
alternateFieldName string <optional>
 An alternate name used in the UI.
isEditable boolean <optional>
 Whether the form field is editable.
isReadOnly boolean <optional>
 Whether the form field is read-only.
isRequired boolean <optional>
 Whether the form field is required.
isNoExport boolean <optional>
 Whether the form field should not be exported.
defaultValue any <optional>
 The default value of the form field.
exportValue any <optional>
 The value exported when the form is submitted.
value any <optional>
 The current value of the form field.
calculationOrderIndex number <optional>
 The calculation order index.
dirty boolean <optional>
 Whether the form field has been modified.
Source:

SignatureFormField

Properties:
Name Type Attributes Description
signatureContents string <optional>
 The contents of the signature.
signatureInfo Object <optional>
 Information about the signature.
isSigned boolean Whether the field is signed.
signatureType 'text' | 'image' | 'drawing' <optional>
 The type of signature.
Source:

TextFormField

Properties:
Name Type Attributes Description
value string The current value of the text field.
placeholder string <optional>
 The placeholder text.
isPassword boolean Whether this is a password field.
isRichText boolean Whether rich text is enabled.
alignment 'left' | 'center' | 'right' The text alignment.
fontSize number The font size.
fontName string <optional>
 The font name.
textColor string <optional>
 The text color.
maxLength number <optional>
 The maximum length of the text.
isMultiline boolean Whether the field is multiline.
doNotScroll boolean Whether scrolling is disabled.
Source: