Signature Form Element

Type: String

Name in Properties Panel: Accessible Description

Name to Use in Expressions: accessibleDescription

An accessible version of the description of the element. The accesible description is not visible on the page; it is hidden.

You can use the Accessible Description property to provide a description that can be used by assistive technologies, such as screen readers.

Type: String

Name in Properties Panel: Button Label

Name to Use in Expressions: prompt

The text that appears on the button that the user clicks to enter a signature. The default text is Sign.

You can format the button's label using Markdown.

Type: String

Name in Properties Panel: Description

Name to Use in Expressions: description

A description of the element. The description appears below the element's title.

You can use the Description property to describe what the element represents or to provide instructions to the user about how to use the element.

You can format the description using Markdown.

Type: String

The element's ID, which is used in other form elements and activities to access the element's properties. The ID must be unique across all elements in the form.

You cannot set the value of the Element ID property in an expression—you can only use the value that you configured for it. To use the Element ID property in an expression:

${Display Form ID}.state.{Element ID}.{property name}

For example:

Type: Boolean

Name in Properties Panel: Enabled

Name to Use in Expressions: enabled

Indicates whether the Signature element is enabled in the running workflow. When a Signature element is enabled, the user can sign their name. When a Signature element is disabled, the user can see the Signature element, but cannot interact with it. Disabled elements appear dimmed or shaded in the running workflow.

By default, Signature elements are enabled. To disable a Signature element, clear the Enabled checkbox. You may want to change the property's value at run time depending on the user's input in a previous form element.

To access the enabled property in an expression:

For example:

Type: String | MarkdownRef

Indicates whether an error occurred in the element.

We recommend using the Set Form Element Error and Clear Form Element Error activities to work with errors in form elements.

Type: String

Name in Properties Panel: Helper Text

Name to Use in Expressions: label

Text to be displayed below the line where the user is to sign their name. The default text is Sign here.

You can format the helper text property using Markdown.

Type: Boolean

Name in Properties Panel: Required

Name to Use in Expressions: require

The Required checkbox is intended as a quick way to do simple validation without having to add a validate event. When you add a validate event, the Required check is not performed even if the checkbox is selected. To force the Required check to be performed when a validate event is configured, add a Propagate Form Event activity anywhere within the event's subworkflow.

Indicates whether the user must sign their name. When the Signature element is required, the user cannot submit the form until a signature has been drawn. .

By default, Signature elements are not required. To require a Signature element , select the Required checkbox.

To access the require property in an expression:

For example:

Type: String

Indicates the name of the style that will be applied to the element.

To access the styleName property in an expression:

For example:

Type: String

Name in Properties Panel: Title

Name to Use in Expressions: title

The element's title, which appears at the top of the element. You may want to change the title to describe what the element represents in your workflow.

You can format the title using Markdown.

Type: String

Name in Properties Panel: Title Location

Name to Use in Expressions: titleLocation

Specifies whether the element's title appears above (default) or beside the element.

The value must be either "above" or "beside".

Type: String

Name in Properties Panel: Tooltip

Name to Use in Expressions: tooltip

A message that displays when the user hovers the mouse pointer over the Signature button. You may want to use the tooltip to provide help to the user.

Type: String

The variety of form element.

Use the type property to find out the variety of a form element in a form with many elements. Loop through ${Display Form ID}.state, comparing each element to the known form types and performing some action on the elements that meet your type criteria.

To access the type property in an expression:

${Display Form ID}.state.{Element ID}.type

For example:

Type: SignatureRef

An object of type SignatureRef that represents the user's signature, containing the image as both a dataUrl and a File.

To access the signature in an expression:

${Display Form ID}.state.{Element ID}.value.dataUrl

${Display Form ID}.state.{Element ID}.value.file

For example:

$form1.state.signature1.value.dataUrl

$form1.state.signature1.value.file

Type: Boolean

Name in Properties Panel: Visible

Name to Use in Expressions: visible

Indicates whether the element is visible to the user. By default, Signature elements are visible. If you want to hide the element, clear the Visible checkbox. You may want to change the visibility at run time depending on the user's input in a previous form element.

To access the visible property in an expression:

${Display Form ID}.state.{Element ID}.visible

For example: