Handling a Progress Bar control by programming

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

Editors

Controls (window/page/report)

Controls

Progress Bar control

Handling a Progress Bar control by programming

Overview

Making the progress bar change

Retrieving the position of the progress bar

Modifying the position of the progress bar

Properties specific to the management of a progress bar

See also

Handling a Progress Bar control by programming

Overview

A Progress Bar control can be handled by programming. To do so, use the variable of the Progress Bar control in the code.

The variable of the Progress Bar control:

corresponds to the name of progress bar.
is initialized with the position of progress bar.

Making the progress bar change

Non-symmetric progress bar (linear or circular)

The progress is performed from the lower bound to the upper bound.

FOR I = PROGBAR_ProgBar1..MinValue _TO_ PROGBAR_ProgBar1..MaxValue
PROGBAR_ProgBar1 = I
END

Symmetric progress bar

The progress is performed as follows:

FOR I = 2 * PROGBAR_ProgBar1..MinValue - PROGBAR_ProgBar1..MaxValue _TO_ PROGBAR_ProgBar1..MaxValue
PROGBAR_ProgBar1 = I
END

Versions 16 and later

Non-symmetric linear horizontal progress bar

Several methods can be used to make a progress bar change in WEBDEV:

Method 1: Performing the process corresponding to the progression of the progress bar in server code. The progress bar is refreshed in browser code by GaugeActivate.
Caution: This code must not be performed in a server process in Ajax mode.
Example:

// -- 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
GaugeActivate(PROGBAR_NoName1, 10)

Note: This method is not available in PHP or in AWP.
Method 2 (method for AWP pages): Performing the process of the progress bar in browser code with GaugeExecute. This function regularly calls a browser WLanguage procedure used to manage the progression of the progress bar. If a server process must be performed, AjaxExecute must be used in the browser procedure.
Caution: To display a progress bar, a long server or browser process must be divided into several processes. This method is recommended for the small repetitive processes (a process that must be performed for a set of images for example).
Example:

// -- Browser code
GaugeExecute(PROGBAR_1, UPD_ProgBar, 0, 100, 10)

// Browser procedure called by the GaugeExecute function
PROCEDURE UPD_ProgBar(nValue)
// Optional code used to perform a server process
AJAXExecute(ServerProcess)

Note: This method is available in PHP and AWP.

Note: Several functions can be used to handle a progress bar in a WEBDEV page. See Functions for managing progress bars for more details.

New in version 16

Non-symmetric linear horizontal progress bar

Several methods can be used to make a progress bar change in WEBDEV:

Method 1: Performing the process corresponding to the progression of the progress bar in server code. The progress bar is refreshed in browser code by GaugeActivate.
Caution: This code must not be performed in a server process in Ajax mode.
Example:

// -- 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
GaugeActivate(PROGBAR_NoName1, 10)

Note: This method is not available in PHP or in AWP.
Method 2 (method for AWP pages): Performing the process of the progress bar in browser code with GaugeExecute. This function regularly calls a browser WLanguage procedure used to manage the progression of the progress bar. If a server process must be performed, AjaxExecute must be used in the browser procedure.
Caution: To display a progress bar, a long server or browser process must be divided into several processes. This method is recommended for the small repetitive processes (a process that must be performed for a set of images for example).
Example:

// -- Browser code
GaugeExecute(PROGBAR_1, UPD_ProgBar, 0, 100, 10)

// Browser procedure called by the GaugeExecute function
PROCEDURE UPD_ProgBar(nValue)
// Optional code used to perform a server process
AJAXExecute(ServerProcess)

Note: This method is available in PHP and AWP.

Note: Several functions can be used to handle a progress bar in a WEBDEV page. See Functions for managing progress bars for more details.

Non-symmetric linear horizontal progress bar

Several methods can be used to make a progress bar change in WEBDEV:

Method 1: Performing the process corresponding to the progression of the progress bar in server code. The progress bar is refreshed in browser code by GaugeActivate.
Caution: This code must not be performed in a server process in Ajax mode.
Example:

// -- 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
GaugeActivate(PROGBAR_NoName1, 10)

Note: This method is not available in PHP or in AWP.
Method 2 (method for AWP pages): Performing the process of the progress bar in browser code with GaugeExecute. This function regularly calls a browser WLanguage procedure used to manage the progression of the progress bar. If a server process must be performed, AjaxExecute must be used in the browser procedure.
Caution: To display a progress bar, a long server or browser process must be divided into several processes. This method is recommended for the small repetitive processes (a process that must be performed for a set of images for example).
Example:

// -- Browser code
GaugeExecute(PROGBAR_1, UPD_ProgBar, 0, 100, 10)

// Browser procedure called by the GaugeExecute function
PROCEDURE UPD_ProgBar(nValue)
// Optional code used to perform a server process
AJAXExecute(ServerProcess)

Note: This method is available in PHP and AWP.

Note: Several functions can be used to handle a progress bar in a WEBDEV page. See Functions for managing progress bars for more details.

Retrieving the position of the progress bar

To retrieve the position of a progress bar, use the following syntax:

<Position> is an integer variable.

Note: You also have the ability to use ..Value.

Modifying the position of the progress bar

To modify the position of a progress bar, use the following syntax:

<Value> is a value found between the minimum value and the maximum value of the progress bar. These values have been described in the description window of the control or by programming with ..MinValue and ..MaxValue.

Note: You also have the ability to use ..Value.

Properties specific to the management of a progress bar

The following properties are used to manage the characteristics of a progress bar by programming.


MaxValue	Used to find out and modify the upper bound of a progress bar.
MinValue	Used to find out and modify the lower bound of a progress bar.
HorizontalAlignment	Used to find out and modify the horizontal alignment of the percentage of progress displayed in the progress bar.
Image	Allows you to find out and modify the image used in a progress bar.
BackgroundImage	Used to find out and modify the background image of a progress bar.
TextProgressBar	Used to find out or modify the text displayed in a progress bar (instead of the percentage).
Vertical	Used to find out whether the progress bar is horizontal or vertical.

To find out the entire list of WLanguage properties that can be used with a Progress Bar control, see Properties associated with the Progress Bar control.