UserGuide

Web Progress Bar

From Xojo Documentation

ProgressBars are designed to indicate that some function of your application is progressing (hence the name) towards its goal or to show capacity. Unlike Sliders, Progress Bars are designed to display a value. They cannot be used for data entry.

An Indeterminate Progress Bar has its property set to True. The Maximum and Value properties are not used.

Commonly used properties are listed below. Refer to WebProgressBar in the Language Reference for the complete list of all events, properties and methods.

Properties

Indeterminate

The Progress Bar displays as indeterminate when True.

Maximum

Specifies the maximum value of the Progress Bar.

Value

The current value of the Progress Bar.

Usage

To update a Progress Bar, you should use a Timer. This code in the Run event handler for a Timer (Mode = Multiple and Period = 500) updates a Progress Bar. When the maximum is reached, the Timer is disabled:

Static counter As Integer
counter = counter + 1
If counter <= ProgressBar1.Maximum Then
ProgressBar1.Value = counter
Else
Me.Enabled = False
End If

The Static keyword declares a variable whose value is remembered between event calls.

Example Project

This ProgressBar example demonstrates using a Progress Bar with a Timer and a Thread and is displays a Progress Wheel while the Thread is running.

Examples/Web/Controls/Progress

See Also

WebProgressBar class; UserGuide:Web UI, UserGuide:Web Progress Wheel, UserGuide:Web Timer topics