Vision - Progress Bar
Component Palette Icon
Visually indicates the progress of some task. Can be used to display any value that has an upper and lower bound.
Properties​
| Property | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Background Color | The background color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector . | Color | .background | Appearance |
| Border | The border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border. Note: The border is unaffected by rotation. Changed in 8.1.21 As of 8.1.21, the "Button Border" and "Other Border" options are removed. | Border | .border | Common |
| Cursor | The mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize. | int | .cursorCode | Common |
| Direction | Determines the direction of progress for this progress bar. | int | .direction | Appearance |
| Enabled | If disabled, a component cannot be used. | boolean | .componentEnabled | Common |
| Font | Font of text on this component. | Font | .font | Appearance |
| Foreground Color | The foreground color of the component. See Color Selector. | Color | .foreground | Appearance |
| Horizontal? | If true, the progress bar will display horizontally, else it will display vertically. Manually resize the progress bar to display vertically. | boolean | .horizontal | Appearance |
| Indeterminate? | When true, the progress bar displays animation indicating that something is happening, but it will take an indeterminate amount of time | boolean | .indeterminate | Behavior |
| Maximum | The maximum value that this progress bar will reach. | int | .maximum | Data |
| Minimum | The minimum value that this progress bar will reach. | int | .minimum | Data |
| Mouseover Text | The text that is displayed in the tooltip which pops up on mouseover of this component. | String | .toolTipText | Common |
| Name | The name of this component. | String | .name | Common |
| Quality | The data quality code for any Tag bindings on this component. | QualityCode | .quality | Data |
| Show Percentage? | If true, the progress bar will display its percentage. | boolean | .stringPainted | Appearance |
| Styles | Contains the component's styles. | Dataset | .styles | Appearance |
| Text Color | New in 8.1.8 The color of the text on the progress bar. | Color | .textColor | Appearance |
| Value | The current state of the Progress Bar. | int | .value | Data |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
Deprecated Properties​
| Property | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Data Quality | The data quality code for any Tag bindings on this component. | int | .dataQuality | Deprecated |
Scripting​
Component Functions​
This component does not have component functions associated with it.
Extension Functions​
This component does not have extension functions associated with it.
Event Handlers​
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page
Customizers​
Examples​
Horizontal Blue Progress Bar​
| Property Name | Value |
|---|---|
| Border | Line Border |
| Value | 85 |
| Foreground Color | 0,0,255 |
| Horizontal? | True |
| Show Percentage? | True |
Wide Vertical Blue Progress Bar​
| Property Name | Value |
|---|---|
| Border | Bevel (Double) |
| Value | 85 |
| Foreground Color | 0,0,255 |
| Horizontal? | False |
| Show Percentage? | True |