Object Model: ProgressBar.Value

ProgressBar.Value

Description

Returns or sets the value of the progress bar as an Integer. By default, the value is 0. If the visibility is set to "true" the ProgressBar is redrawn to reflect the new position.

Note: Attempting to set the value to be greater than the maximum value or less than the minimum value will result in an error.

C# Syntax

// get accessor
Int32 rtn = ProgressBar.Value;
// set accessor
ProgressBar.Value = Int32;

Examples

VBScript Example

dim progressbar
set progressbar = XSIUIToolkit.ProgressBar
progressbar.Maximum = 70
progressbar.Step = 1
progressbar.CancelEnabled = false
progressbar.Visible= true
for i = 1 to 60
        progressbar.Caption = "step" & i
        progressbar.Increment 1
next
Application.LogMessage( progressbar.Value )
' Expected result:
'INFO : 60