Number Range Slider Form Element
The Number Range Slider form element allows the user to select a range of numbers using a slider control or by typing numbers in the Start and End fields.
To use a Number Range Slider, drag the Start handle to the left or right (). The Start field box shows the currently selected number. Then drag the End handle to the left or right (). The End field box shows the currently selected number. Alternatively, the user can use the arrows to change the number () or type a number directly into the Start or End field boxes.
Example of the Number Range Slider form element, shown in a viewer
The Number Range Slider can also be manipulated using keyboard shortcuts. To use keyboard shortcuts, select the Number Range Slider form element with a left-click. Alternatively, you can use the Tab key to toggle between controls until the desired element's control has been selected. You can reverse the tabbing toggle direction by clicking Shift+TAB. Once the desired control has been selected, use the arrow keys to increase or decrease the value. This works for the manual input fields as well as the slider's endpoints.
The Start and End field's numeric value is increased with the Up arrow key and decreased with the Down arrow key.
The slider's endpoints are manipulated with the arrow keys; Down or Left to decrease the value and Up or Right to increase the value.
See also...
Number Range Slider Properties
The Properties table describes the properties of the
The type of a property defines what types of values the property can have. Many properties are type string, which means that the property's value is text. Boolean properties can be true
or false
. Some properties have more than one possible type.
Property names in Workflow Designer's Properties panel are written using the capitalization and spacing of a title. Property names in expressions are valid JavaScript identifiers and start with a lower case letter.
In the table below:
- If a property can be accessed in both the Properties panel and expressions, then the table gives both versions of the name.
- If a property's name in the table starts with a lower case letter, then you can only access the property in expressions.
- If a property's name starts with a capital letter and the table does not give a name to use in expressions, then you can only access the property in the Properties panel.
Expressions are case sensitive. When you access a form element property in an expression, you must use the correct capitalization.
Properties of the Number Range Slider Form Element
Accessible Description |
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. |
Currency |
Type: String Name in Properties Panel: Currency Name to Use in Expressions: format.currency The currency to display in Currency or Accounting formats. This property is only shown when the Number Format property is set to "Currency" or "Accounting". The value must be a valid ISO 4217 Currency Code. To access the ${Display Form ID}.state.{Element ID}.format.currency
For example: $form1.state.
|
Custom Format |
Type: String Name in Properties Panel: Custom Format Name to Use in Expressions: format.customDisplayFormat The custom format to display numbers in. This property is only shown when the Number Format property is set to "Custom". Relevant and additional information on custom number formatting can be found at Microsoft's Custom Numeric Format Strings. To access the ${Display Form ID}.state.{Element ID}.format.customDisplayFormat
For example: $form1.state.
|
Decimal Places |
Type: Number The number of decimal digits to show, for example:
The value cannot be negative. |
Default Values |
Type: String The numbers that appear in the Start and End fields. This controls the initial end points of the range slider. If you leave the Default Value blank, the Start and End fields will default to the Minimum and Maximum values. Each Default Value is entered one per line (). The first number on the first line represents the default lowest value () of the range. The second number on the second line represents the default highest value () in the range. Exactly two (2) values are processed. Entering one (1) value will be ignored by the system. Entering three (3) or more values results in the system processing the first two (2) values only.
Default values example for the Number Range Slider
The default Start value cannot be less than the Minimum value. The default End value cannot be greater than the Maximum value. |
Description |
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. |
Element ID |
Type: String The element's ID, which is used in other form elements and activities to access the element's properties 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: $form1.state.
|
Enabled |
Type: Boolean Name in Properties Panel: Enabled Name to Use in Expressions: enabled Indicates whether the By default, To access the ${Display Form ID}.state.{Element ID}.enabled
For example: $form1.state.
|
error |
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. |
Maximum |
Type: Number
|
Minimum |
Type: Number
|
Number Format |
Type: String Name in Properties Panel: Number Format Name in expressions: format.displayFormat Available number formats:
Relevant and additional information on custom number formatting can be found at Microsoft's Custom Numeric Format Strings. |
Show Inputs |
Type: Boolean Name in Properties Panel: Show Inputs Name to Use in Expressions: manualEntry Indicates whether inputs should be displayed for manual user entry. Inputs are visible by default. If you want to hide the element, clear the Show Inputs checkbox.
Inputs used for manual entry You may want to change the visibility at run time depending on the user's input in a previous form element. To access the ${Display Form ID}.state.{Element ID}.manualEntry
For example: $form1.state.
|
Show Min/Max Labels |
Type: Boolean Name in Properties Panel: Show Min/Max Labels Name to Use in Expressions: showMinMaxLabels Indicates whether to display the Minimum/Maximum labels under the slider bar.
Min and Max labels shown under the slider You may want to change the visibility at run time depending on the user's input in a previous form element. To access the ${Display Form ID}.state.{Element ID}.showMinMaxLabels
For example: $form1.state.
|
Show Tick Marks |
Type: Boolean Name in Properties Panel: Show Tick Marks Name to Use in Expressions: showTickMarks Indicates whether to display tick marks for the slider.
Tick Marks shown on the Number Range Slider Based on the screen resolution and the Step Size value, individual tick marks may not be distinguishable as they would visually blend together. In this case, they would appear as a thicker range slider line. To access the ${Display Form ID}.state.{Element ID}.showTickMarks
For example: $form1.state.
|
Type: Number The amount by which the number in the |
styleName |
Type: String
Indicates the name of the style that will be applied to the element. To access the ${Display Form ID}.state.{Element ID}.styleName
For example: $form1.state.
|
Title |
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. |
Title Location |
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 |
Tooltip |
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
|
type |
Type: String The variety of form element. Use the To access the ${Display Form ID}.state.{Element ID}.type For example: $form1.state.
|
value |
Type: Number[] An array of numbers that represents the currently selected start and end values. To access the values in an expression:
For example:
|
Visible |
Type: Boolean Name in Properties Panel: Visible Name to Use in Expressions: visible Indicates whether the element is visible to the user. By default,
To access the ${Display Form ID}.state.{Element ID}.visible For example: $form1.state.
|
Number Range Slider Events
The following table describes the events associated with the
Events for the Number Range Slider Form Element
load |
The
You can use the |
change |
The You can use the The |
drag |
The drag event is repeatedly fired while an input is dragged. The drag event fires every time the user's selection changes by one Step Size. This means that the drag subworkflow can run multiple times. Because of this, you should make sure that the drag subworkflow is not computationally intensive or long running. |