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

applyFormFields()

Applies all form field annotations as PDF Fields with associated Widgets

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.

getAnnotationFlags(formfieldPlaceHolder)

Returns a Widget Flags object based on the flags set in the form field place holder
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
Returns:
WidgetFlags

getFieldFlag(formfieldPlaceHolder, fieldFlag)

Returns true or false depending on whether a flag is set on the form field place holder
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
fieldFlag A string representing the field flag
Returns:
boolean representing whether flag is set

getFieldLabels()

Returns the labels being used to store the field custom data

getFieldName(formfieldPlaceHolder)

Gets the field name from the form form field place holder
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
Returns:
string Field name

getFieldOptions(formfieldPlaceHolder)

Gets the field options associated with the form field place holder
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder

getFieldValue(formfieldPlaceHolder)

Gets the field value from the form form field place holder
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
Returns:
string Field value

getIndicatorText(formfieldPlaceHolder)

Gets whether or not the form field indicator should be shown
Parameters:
Name Type Description
formfieldPlaceHolder Core.Annotations.Annotation The form field place holder
Returns:
Whether or not to show the field indicator
Type
boolean

getRadioButtonGroups()

Gets the existing radio button groups
Returns:
string[] Array with Radio Button group names

getShowIndicator(formfieldPlaceHolder)

Gets whether or not the form field indicator should be shown
Parameters:
Name Type Description
formfieldPlaceHolder Core.Annotations.Annotation The form field place holder
Returns:
Whether or not to show the field indicator
Type
boolean

getSignatureOption()

Gets the signature option for signature widget place hodlers returns either fullSignature, or initials
Returns:
One of the signature options, either fullSignature or initials
Type
Core.FormFieldCreationManager.SignatureOptions

getWidgetFromPlaceholder(placeholderAnnotation)

Gets the associated widget from the given placeholder annotation.
Parameters:
Name Type Description
placeholderAnnotation Annotations.Annotation The placeholder annotation that appears in form builder mode.
Returns:
The associated widget annotation if it exists.
Type
Annotations.Annotation | null

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

setFieldFlag(formfieldPlaceHolder, fieldFlag, boolean)

Set a field flag as true or false Available field flags are those listed in custom data labels
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
fieldFlag The field flag name
boolean Value for the flag

setFieldName(formfieldPlaceHolder, fieldName)

Set the form field placeholder name
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
fieldName The field name

setFieldOptions(formfieldPlaceHolder, options)

Sets the options list on the form field place holder
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
options The options, an array of objects with a value and displayValue property

setFieldValue(formfieldPlaceHolder, fieldValue)

Set the field default value
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
fieldValue The field value

setIndicatorText(formfieldPlaceHolder, indicatorText)

Set the field indicator text
Parameters:
Name Type Description
formfieldPlaceHolder Core.Annotations.Annotation The form field place holder
indicatorText string The indicator text

setShowIndicator(formfieldPlaceHolder, showIndicator)

Set whether or not to show the field indicator
Parameters:
Name Type Description
formfieldPlaceHolder Core.Annotations.Annotation The form field place holder
showIndicator string Whether or not to show the field indicator

setSignatureOption(formfieldPlaceHolder, signatureOption)

Sets whether a Signature Widget should take in a full signature, or initials
Parameters:
Name Type Description
formfieldPlaceHolder The form field place holder
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