ProgressBarEnable (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Functions specific to WEB

Functions for managing progress bars

ProgressBarEnable

Presentation

Example

See also

ProgressBarEnable (Function)

In french: JaugeActive

Warning
From version 24, GaugeActivate is kept for backward compatibility. This function is replaced by ProgressBarEnable.

Enables the refresh of a Progress Bar via Ajax.

Caution: This function cannot be used in a PHP or AWP site.

Example

See additional examples

// Display the Progress Bar in the middle of the screen in a cell with DDW
CellDisplayDialog(CELL_ProgBar)
// Start monitoring the progress of the copy
ProgressBarEnable(PROGBAR_Copy)

// -- Server code of BTN_Process button
FOR I = PROGBAR_NoName1..MinValue _TO_ PROGBAR_NoName1..MaxValue
PROGBAR_NoName1 = I
Multitask(-1)
END

// -- Browser code of BTN_Process button
ProgressBarEnable(PROGBAR_NoName1, 10)

Syntax

ProgressBarEnable(<Progress Bar control> [, <Period> [, <Automatic stop>]])

<Progress Bar control>: Character string (with or without quotes)

Progress Bar control to use.

<Period>: Optional integer or optional Duration

Period for refreshing the Progress Bar in hundredths of a second. This parameter can correspond to:
an integer corresponding to the number of hundredths of a second,
a Duration variable,
Versions 23 and later
the direct indication of duration ('1s', '10cs' or '10ms' for example).
New in version 23
the direct indication of duration ('1s', '10cs' or '10ms' for example).
the direct indication of duration ('1s', '10cs' or '10ms' for example).
This period is set to 1000 hundredths of a second by default.

<Automatic stop>: Optional boolean

Indicates whether the refresh of the progress must be stopped automatically (True, default value) at the end of the server call.

Remarks

The refresh of the Progress Bar is regularly performed from the browser by interrogating the server.

In server code, the position of the progress bar is changed by modifying the value (..Value property) of the Progress Bar control.

The refresh being provoked by the browser, the modifications in server code may not be immediately applied to the browser control.

Caution: The server should not be called too often to avoid performing too many requests.

Component : WDJS.DLL