ProgressBar (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Erasing the progress bar
Status Bar
Progress bar and MDI child window
Limitations

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

ProgressBar (Function)

In french: Jauge

Warning
From version 24, Gauge is kept for backward compatibility. This function is replaced by ProgressBar.

Displays a progress bar in the status bar of current window.

Remark: The window must have a status bar.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 18 and later

This function is now available in Android Widget mode.

New in version 18

This function is now available in Android Widget mode.

Example

Maxim is int = 234
FOR i = 1 TO Maxim
ProgressBar(i, Maxim, "There is " + (Maxim-i)*100/Maxim + "% left")
END

Syntax

Displaying the progress bar Hide the details

ProgressBar(<Value of Progress Bar> [, <Maximum value> [, <Text of Progress Bar> [, <Color>]]])

<Value of Progress Bar>: Integer

Increment value of progress bar. This value must be included between 0 and <Maximum Value>.

<Maximum value>: Optional integer

Maximum possible value of progress bar. If this parameter is not specified, the maximum value of the progress bar is set to 100.

<Text of Progress Bar>: Optional character string

Caption displayed on the right of the progress bar. If this parameter is not specified, the text displayed has the following format: "NN%" where NN represents the percentage of <Value of Progress Bar> in relation to <Maximum Value>.
For example: 45%.

<Color>: Integer or constant (optional)

Color of progress bar. This color can correspond to:
an RGB color (returned by RGB),
an HSL color (returned by HSL),
a preset color of WLanguage.
If this parameter is not specified, the color used corresponds to the color of the selected elements. This color is defined in the display properties of the current computer (control panel, "Display" option, "Appearance" tab in Windows NT).

Erasing the progress bar

ProgressBar()

Remarks

Erasing the progress bar

If a text was displayed in the status bar before the progress bar was displayed, this text is restored when the progress bar is erased.

Status Bar

To display the status bar in a window, check "Status Bar" in the "Style" tab of the window description.

Progress bar and MDI child window

ProgressBar, used from an MDI child window without status bar, uses the status bar of the parent window.

Limitations

The following limitations exist for Android:

The progress bar will be displayed on the maximized windows that include a title bar.
The text or the color of the progress bar cannot be specified.
The maximum value of the progress bar must be included between 0 and 10000.
The progress bar is automatically hidden when it reaches its maximum value. The call to ProgressBar without parameters is used to hide the progress bar before it reaches its maximum value.

Component : wd250obj.dll