The panel graphicaly displays the percentual and data progress of the transfer.
This preconfiguration can be activated when creating a new object (e.g. by "New object"
in the local object menu or by pressing the Insert
key after selecting the object) and is included in the group: " / Panels (PmPanel) / Progress bar"
This preconfiguration can be used with the objects: PmFolder, PmRoot, PmPanel or PmWorkspace.
- Preconfiguration creates an object of type PmPanel
- The preconfiguration is created not
including the panel functionality as a Web panel
Execution can be launched via the Start method
of the PmPanel
object. The progress is displayed by repeated calling of the Step
method, that receives the parameter indicating the current progress state (transferred data). The panel is closed automaticaly as soon as the value of the Step
method parameter reaches the maximum value defined in the nMaxSteps
If the value of the nMaxSteps variable is set to -1 (infinity), then the panel is not closed automaticaly, but must be called manualy.
In the method Start
there are following variables:
- nMaxSteps final maximum data volume (not defined=-1).
- sText panel description text
- sTitle window header text.
These configurators can be set before the preconfiguration is created:
|The name of created object||Name of the object created in the application object tree. This is a system name and must not contain diacritics, empty string, spaces and the first character must not be a number.|
|Permissions||On this page permissions of the object are defined. See Description of the page Permissions.|
|Progress status text||Progress status text|
Practically the Start
method will be called, when a certain proces
, that can be displayed as progress box, is launched . Next, the PmTimer
object is launched that is used for repeated calling of the Step
method. The Step
method is provided with a parameter indicating the progress of the process
(The preconfiguration Panel is named ProgressBox, located in PmRoot of the application.)
The example of calling the method Start.
The example of calling the method Step.
nStep = X ' X = the current value of transferred data
The example of calling the method Stop. It is relevant only if nMaxSteps=-1
This preconfiguration is used in PreCfg - Preconfiguration examples