Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Component Palette Icon:

On_this_page


Visually indicates the progress of a task. Can be used to display any value that has an upper and lower bound.

Properties

NameDescriptionProperty TypeScriptingCategory
Background ColorThe 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.backgroundAppearance
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

Note_friendly

The border is unaffected by rotation.

Editor_notes

Delete "Button Border" and "Other Border" from above list and make this visible upon 8.1.21 release

Changed_in
Version8.1.21


As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
DirectionDetermines the direction of progress for this progress bar.int.directionAppearance
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
FontFont of text on this component.Font.fontAppearance
Foreground ColorThe foreground color of the component. See  Color Selector .Color.foregroundAppearance
Horizontal?If true, the progress bar will display horizontally, else it will display vertically. Manually resize the progress bar to display vertically. boolean.horizontalAppearance
Indeterminate?When true, the progress bar displays animation indicating that something is happening, but it will take an indeterminate amount of timeboolean.indeterminateBehavior
MaximumThe maximum value that this progress bar will reach.int.maximumData
MinimumThe minimum value that this progress bar will reach.int.minimumData
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Show Percentage?If true, the progress bar will display its percentage.boolean.stringPaintedAppearance
StylesContains the component's styles.Dataset.stylesAppearance
Text Color
New_in
Version8.1.8


The color of the text on the progress bar.

Color.textColorAppearance
ValueThe current state of the Progress Bar.int.valueData
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated

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. 

Examples

Panel
titleHorizontal Blue Progress Bar

Property NameValue
BorderLine Border
Value85
Foreground Color0,0,255
Horizontal?True
Show Percentage?True
Panel
titleWide Vertical Blue Progress Bar

Property NameValue
BorderBevel (Double)
Value85
Foreground Color0,0,255
Horizontal?False
Show Percentage?True