PROGRESSBAR STEP statement

Purpose | Manipulate a PROGRESSBAR control. A ProgressBar is a rectangle that is gradually filled, left to right, as some work progresses.

Syntax

PROGRESSBAR GET POS hDlg, id& TO datav&

PROGRESSBAR GET RANGE hDlg, id& TO LoDatav&, HiDatav&

PROGRESSBAR SET POS hDlg, id&, position&

PROGRESSBAR SET RANGE hDlg, id&, lolimit&, hilimit&

PROGRESSBAR SET STEP hDlg, id&, stepval&

PROGRESSBAR STEP hDlg, id& [,incramt&]

hDlg | Handle of the dialog that owns the ProgressBar.
id& | The control identifier assigned with CONTROL ADD PROGRESSBAR.

Remarks

In each of the following samples and descriptions, the PROGRESSBAR control that is the subject of the statement is identified by the handle of the dialog that owns the ProgressBar (hDlg), and the unique control identifier you gave it upon creation in CONTROL ADD PROGRESSBAR. To alter the color of the bar or the background, use CONTROL SET COLOR.

PROGRESSBAR GET POS hDlg, id& TO datav&

The current position of the ProgressBar is retrieved and assigned to the variable designated by datav&.

PROGRESSBAR GET RANGE hDlg, id& TO LoDatav&, HiDatav&

The current range of the ProgressBar is retrieved and assigned to the variables designated by LoDatav& and HiDatav&. Upon ProgressBar creation, the default range is 0 to 100.

PROGRESSBAR SET POS hDlg, id&, position&

The current position of the ProgressBar is set to the value of the parameter position&, and the bar is redrawn to reflect the new position.

PROGRESSBAR SET RANGE hDlg, id&, lolimit&, hilimit&

The range for the ProgressBar is specified to be from lolimit& to hilimit&. If lolimit& is greater than hilimit&, the results are undefined.

PROGRESSBAR SET STEP hDlg, id&, step&

The default increment value to be used by PROGRESSBAR STEP is specified by the stepval& parameter.

PROGRESSBAR STEP hDlg, id& [,incramt&]

The ProgressBar is "stepped". The current position is advanced by the step increment, and the bar is redrawn to reflect the new position. If the optional incramt& expression is included, the position is advanced by that amount instead. The default step increment is 10, and the default range is from 0 to 100.

See also | Dynamic Dialog Tools, CONTROL ADD PROGRESSBAR, CONTROL SET COLOR, CONTROL SET FONT