Progress Bar
- Last UpdatedJun 28, 2024
- 7 minute read
Basic
|
Property |
Description |
|---|---|
|
Name |
Name that identifies the control. This value is also used for the label of the control. |
|
XML Node |
(Required) XML node mapped to the control. Use this value to map a list to a form and a form to a workflow.
Note: |
|
Description |
Description for the control. |
|
Enable Column Bindings |
Enable this option to set up the lookup source.
The default value is No. |
|
Lookup Source |
(Required) Name of the item from the lookup list. Note: This is only visible when the Enable Column Bindings property is set to Yes. To add a name of the item for the control from the lookup list:
|
|
Unit of Measurement |
Unit of measurement for the value of the control. This supports a single line with 24 characters and a tooltip is shown when you hover over this property. An ellipsis is added if it exceeds the 24-character limit. |
|
Target Value |
Target value of the control. This is the value that the target indicator points at. However, if this property is left blank, the target indicator is not shown at preview or runtime. The default value is 0. |
|
Default Value |
This is the value of the control. This supports 10 characters and a tooltip is shown when you hover over this property. An ellipsis is added if the value exceeds the 10-character limit. |
Appearance
|
Property |
Description |
|---|---|
|
Visible |
Show or hide the control.
|
|
Label Position |
Position of the label for the control.
Note: If the value is Default and the control is placed on a container control, then the value of the Label Position property of the container control determines the position of the label for the control. |
|
Label-Control Area |
Area occupied by the label and the control in percentage.
Note: If the value is Default and the control is placed on a container control, then the value of the Label-Control Area property of the container control determines the area of the label for the control. |
|
Width |
Width in pixels for the control. The default value is 0. Note: If the value is 0, then the width of the control is set as per the default value of 360. |
|
Retain Space |
Reserve or remove space when the control is hidden.
|
|
Title |
Name or information text for the control. It is shown directly above the top-left corner of the control. This supports two lines with 35 characters for each line and a tooltip is shown when you hover over this property. An ellipsis is added if it exceeds the 35-character limit. If you want to add a line break, use the html tag <br>. Note: If this property is not configured or blank, nothing is shown, the other control contents use its space, and the control size is adjusted based on the available content within the control. The described behavior also applies to the Unit of Measurement property. |
|
Decimal Places |
Decimal places for the default value of the control. It also applies to the values in the Range property. This displays a maximum number of 3 decimal places. The default value is 0. Note: At runtime, if this property is empty or has a non-numeric value, it resets back to 0. If its value is greater then 3, it stays at its maximum value of 3. |
|
Scale Minimum Value |
(Required) Minimum value displayed on the scale. The default value is 0. Note: At runtime, if this property is empty or has a non-numeric value, its value is set to 0. |
|
Scale Maximum Value |
(Required) Maximum value displayed on the scale. The default value is 100. Note: At runtime, if this property is empty or has a non-numeric value, its value is set to 100. |
|
Scale |
Show or hide the scale, or use the Range property values in the control.
If this is set to Show, the Number of Division property is visible. The default is Hide. |
|
Number of Division
|
Number of division within the scale, from the minimum value to the maximum value. This number divides the difference between the Scale Maximum Value and Scale Minimum Value. For example:
So the difference between the scale max and min values is 200. The difference divided by the number of division is 40. The scale tick marks are then shown as 0, 40, 80, 120, 160, and 200. Note: This is only visible when the Scale property is set to Show. The default value is 10. |
|
Control Background Color |
The color to represent the background of the control. The default is white. |
|
Background Color |
The color to represent the background of the bar in the control. The default is gray. |
|
Bar Color |
The color to represent the bar in the control. The default is green. |
|
Range |
The breakpoint to apply in the control range bar. Each added row corresponds to a breakpoint and for each breakpoint value, you can assign a color. You can have a maximum of 10 breakpoints. Note: If the configured range does not cover the full scale, the undefined range takes the color that is set for the Bar Color property. The value for the breakpoint must be between the specified value for the Scale Minimum Value and Scale Maximum Value properties. |
|
Custom Style Sheet Identifier |
Prefix for the CSS class name in the custom style sheet. For information about using custom style sheets, see Custom Styles. Note: The value must start with an alphabet and can contain only alphanumeric characters. |
Advanced
|
Property |
Description |
|---|---|
|
On Initialize |
Run a script after the control has been initialized, but before it is rendered to the UI. For more information, see Scripting Guidelines. |
|
ID |
Reference identification code for the control. This value is automatically generated and cannot be changed. |
|
Enable Refresh |
Enable or disable control refresh.
|
|
Refresh Rate |
This is how often the control display is refreshed, in seconds, to fetch value from the data source. Note: This is only visible if the Enable Refresh property is set to Yes. The default is 30 seconds and the valid refresh rate is from 5 to 600 seconds. |
Scripts
For information about using scripts, see scripting guidelines for Progress Bar control.