Number Form Element

Type: String

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: Number

The number that initially appears in the Number box. If you leave Default Value blank, the Number box will initially be blank.

If you leave Default Value blank and the user does not enter a value, the number will be null. To prevent a null number, make the number required.

Type: String

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

You cannot get or 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:

$form1.state.number1.visible

Type: Boolean

Name in Properties Panel: Enabled

Name to Use in Expressions: enabled

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

By default, number elements are enabled. To disable an element initially, 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:

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

For example:

$form1.state.number1.enabled

Type: String | MarkdownRef

Indicates whether an error occurred in the element.

MarkdownRef objects have a markdown property of type String that represents the Markdown text.

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

Type: Number

The minimum value that the user can enter. If you leave Lower Bound blank, the minimum value will be JavaScript's minimum value.

Type: Number

They number of decimal digits to show, for example:

• 0 shows integers (...-2, -1, 0, 1, 2...), for example, 154 or -12;

• 1 shows one decimal place (...-0.2, -0.1, 0, 0.1, 0.2...), for example, 1.9 or -52.0;

  2 shows two decimal places (...-0.02, -0.01, 0, 0.01, 0.02...), for example, 94800.01 or -16.99;

  and so on.

• -1 rounds to the nearest ten (...-20, -10, 0, 10, 20...), for example, 6040 or -330;

  -2 rounds to the nearest hundred (...-200, -100, 0, 100, 200...), for example, 42100 or -800;

  and so on.

The value must be within the lower and upper bounds. If the user types in a number that is below the lower bound, the number is rounded up to the lower bound. If the user types in a number that is above the upper bound, the number is rounded down to the upper bound.

Type: Boolean

Name in Properties Panel: Required

Name to Use in Expressions: require

Indicates whether the user must enter a number in the Number box. When the number is required, the user cannot submit the form until a number has been entered.

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

The Required checkbox is intended as a quick way to do simple validation without having to add a validate event. If you add a validate event to a form element, selecting the Required checkbox will not have any effect. In this case, you must make the validate event check whether the user entered a value.

To access the require property in an expression:

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

For example:

$form1.state.number1.require

Type: Number

The amount by which the number in the Number box increases or decreases each time the user clicks the up arrow or down arrow . If you leave Step Size blank or you enter a step size that is 0 or negative, the step size will be 1.

Type: String

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. Descriptive titles make forms easier to understand.

You can format the title using Markdown.

Type: String

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

Type: String

The variety of form element. Number elements are type "Number".

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:

$form1.state.number1.type

Type: Number

The maximum value that the user can enter. If you leave Upper Bound blank, the maximum value will be JavaScript's maximum value.

Type: NumberRef

The currently entered number.

NumberRef objects have a display property of type String that represents the display value of the number and a numeric property of type Number that is the actual number value.

To access the value property in an expression:

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

For example:

$form1.state.number1.value

The load event fires when the element finishes loading.

You can use the load event to set one or more of the element's properties at run time. For example, you could set the number element's initial value.

The change event fires when the user clicks an arrow or clicks away from the number box after changing the number in the box.

You can use the change event to create dependencies between form elements. For example, you could configure a change subworkflow that enables or disables other form elements depending on the user's input.

The change event fires every time the user's input changes by one Step Size. This means that the number element's change subworkflow can run multiple times. Because of this, you should make sure that the change subworkflow is not computationally intensive or long running.