1. Getting started

This chapter is used to introduce you to how to easily set up a progress bar.

The steps that will be discussed are applicable for both types of progress bar.

We will use the default values of the properties for this example. You are free to consult the list of formulas if you wish to customize your bar during this presentation.

The first step is to add an image object to a form. This one will be used to host the progress bar. You can add other image objects if you want to generate several progress bars simultaneously.

The second step requires to create an instance, you can choose to launch one of the two methods to create an instance of the component (circular or linear bar). Ideally, the object returned by the method of your choice should be stored in the "Form" variable, it is also recommended to add a level to the "Form" object. For example, "Form.progressbar".

Once this is done, add the name of your image form object to the instance. Then for your test, we propose you to modify the value of the current progression which is by default 0 and to activate the animations. All you have to do is launch the corresponding "launch" formula to generate your progress bar.

Repeats the second step for each image form object if you have created several (one instance per image object). Also tried to use the formula to activate the "barbershop" animation. Don't forget to create a button to activate the formula that stops this animation (see the chapter : Formulas to manage the progress bar).

Sample from the code for a linear progress bar :

Form.mypb:=New object
Form.mypb:=New AJUI_ProgressBar

Form.mypb.PBActivateAnimation (True)
Form.mypb.PBPercentValue (60)
Form.mypb.PBPictFormObjName ("AJUI_BPPict_container")

Form.mypb.LaunchProgressBar ( )

We also advise you to launch the example forms with the prefixed methods "HDI" of the component to get an idea of what it looks like visually and discover some use cases where AJUI ProgressBar brings you a real added value.

AJUI_Progressbar classes

Since V18R3, you can replace the instances returned by New AJUI_CircularProgressBar and New AJUI_ProgressBar by calling the CircularProgressBar and ProgressBar classes. The functions of these two classes use the same names and the same parameters as for the formulas obtainable by the old procedure. The default values are also the same.

The only difference in terms of code is when creating the instance :

  //with the formulas
    $myCPB:=New AJUI_CircularProgressBar ()
    $myPB:=New AJUI_ProgressBar ()

  //with the classes
    $myCPB:=AJUI_CircularProgressBar.new ()
    $myPB:=AJUI_ProgressBar.new ()