Increment (ProgressBar)

Description

Advances the current position for the progress bar control by the specified number of steps. If the visibility is set to true the ProgressBar is redrawn to reflect the new position.

Scripting Syntax

    ProgressBar.Increment( [IncrementValue] )

C# Syntax

    Int32 ProgressBar.Increment( Int32 in_intIncrement );

Parameters

Parameter | Type | Description
IncrementValue | Integer | The amount to increment the current value. A value less than zero is invalid and will result in an "invalid argument" error. Default Value: 1

Return Value

Integer

Examples

VBScript Example

    dim progressbar
    set progressbar = XSIUIToolkit.ProgressBar
    progressbar.Maximum = 70
    progressbar.Step = 1
    progressbar.Visible= true
    for i = 1 to progressbar.Maximum
       progressbar.Increment 1
    next

Autodesk Softimage v7.5