Apryse WebViewer

Class: FormFieldCreationManager

Core. FormFieldCreationManager

A manager class that controls form field creation and editing

new FormFieldCreationManager()

Extends

  • EventHandler

Members

<static> Events

Properties:
Name Type Description
FORM_CREATION_STARTED string Core.FormFieldCreationManager.formFieldCreationModeStarted
FORM_CREATION_ENDED string Core.FormFieldCreationManager.formFieldCreationModeEnded
FORM_CREATION_EMPTY_FIELD_NAMES string Core.FormFieldCreationManager.formFieldEmptyFieldNames

Methods

allowToolsInFormFieldCreationMode(tools)

Adds tools to the list of tools that are allowed to be used in form field creation mode
Parameters:
Name Type Description
tools The names of the tools to be added

disallowToolsInFormFieldCreationMode(tools)

Removes tools from the list of tools that are allowed to be used in form field creation mode
Parameters:
Name Type Description
tools the names of the tools to be removed

enableShowingMarkupAnnotations()

Enables the display of markup annotations during form field creation.

enableShowingMarkupAnnotations()

Disables the display of markup annotations during form field creation.

endFormFieldCreationMode()

Ends the Form Field Creation mode, converting all the form field place holder annotations into Widget annotations with their respective fields.

getFieldLabels()

Returns the labels being used to store the field custom data
Returns:
The labels used to store the field custom data
Type
Object

getIndicatorText(widgetAnnotation)

Gets the field indicator text
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The Widget Annotation to pull the field indicator text from
Returns:
The field indicator text
Type
string

getRadioButtonGroups()

Gets the existing radio button groups
Returns:
Array with Radio Button group names
Type
Array.<string>

getShowIndicator(widgetAnnotation)

Gets whether or not the form field indicator should be shown
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The Widget Annotation to pull the field indicator flag from
Returns:
Whether or not to show the field indicator
Type
boolean

getSignatureOption(signatureWidget)

Gets the signature option for signature widgets. Returns either fullSignature or initials
Parameters:
Name Type Description
signatureWidget Core.Annotations.SignatureWidgetAnnotation The Widget Annotation to pull the signature option from
Returns:
One of the signature options - either fullSignature or initials
Type
Core.FormFieldCreationManager.SignatureOptions

isInFormFieldCreationMode()

Gets if the Form Field Creation manager is currently in creation mode

isShowingMarkupAnnotations()

Checks if markup annotations are being displayed during form field creation.
Returns:
True if markup annotations are shown during form field creation.
Type
boolean

setFieldName(widget, fieldName)

Sets the form field name.
Parameters:
Name Type Description
widget Core.Annotations.WidgetAnnotation The form field widget
fieldName string The field name

setIndicatorText(widgetAnnotation, indicatorText)

Set the field indicator text
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The Widget Annotation to set the field indicator text on
indicatorText string The indicator text

setShowIndicator(widgetAnnotation, showIndicator)

Set whether or not to show the field indicator
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The Widget Annotation to set the field indicator flag on
showIndicator string Whether or not to show the field indicator

setSignatureOption(signatureWidget, signatureOption)

Sets whether a signature widget should take in a full signature, or initials.
Parameters:
Name Type Description
signatureWidget Core.Annotations.SignatureWidgetAnnotation The signature widget
signatureOption Core.FormFieldCreationManager.SignatureOptions The type of signature

startFormFieldCreationMode()

Starts the Form Field Creation mode, a mode in which all annotations are hidden and only form field place holder annotations can be added

Type Definitions

SignatureOptions

Signature Options
Type:
  • 'fullSignature' | 'initialsSignature'

Events

formFieldCreationModeEnded

Triggered when form field creation mode is ended

formFieldCreationModeStarted

Triggered when form field creation mode is started