Top  | Previous | Next

Progress Bar

display_Progressbar

Description

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

Properties

Appearance

Font

Font of text of this component

Scripting name

font

Data type

Font

Foreground Color

The foreground color of the component.

Scripting name

foreground

Data type

Color

Background Color

The background color of the component.

Scripting name

background

Data type

Color

Horizontal?

If true, the progress bar will display horizontally, else it will display vertically

Scripting name

horizontal

Data type

boolean

Show Percentage?

If true, the progress bar will display its percentage.

Scripting name

stringPainted

Data type

boolean

Direction

Determines the direction of progress for this progress bar.

Scripting name

direction

Data type

int

Flags

expert

Values

0

Left to Right

1

Right to Left

Antialias

Draw with antialias on? Makes text smoother

Scripting name

antialias

Data type

boolean

Flags

expert

Styles

Contains the component's styles

Scripting name

styles

Data type

Dataset

Flags

bindable | expert

Behavior

Indeterminate?

When true, the progressbar displays animation indicating that something is happening, but it will take an indeterminate amount of time

Scripting name

indeterminate

Data type

boolean

Flags

bindable

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Enabled

If disabled, a component cannot be used.

Scripting name

componentEnabled

Data type

boolean

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Mouseover Text

The text that is displayed in the tooltip which pops up on mouseover of this component.

Scripting name

toolTipText

Data type

String

Cursor

The mouse cursor to use when hovering over this component.

Scripting name

cursorCode

Data type

int

Values

0

Default

1

Crosshair

2

Text

3

Wait

12

Hand

13

Move

4

SW Resize

5

SE Resize

6

NW Resize

7

NE Resize

8

N Resize

9

S Resize

10

W Resize

11

E Resize

Data

Value

The current state of the Progress Bar.

Scripting name

value

Data type

int

Flags

bindable

Maximum

The maximum value that this progress bar will reach

Scripting name

maximum

Data type

int

Flags

bindable

Minimum

The minimum value that this progress bar will reach

Scripting name

minimum

Data type

int

Flags

bindable

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

mouse
mouseMotion
propertyChange

 

Scripting Functions

This component has no special scripting functions.