Progress Indicator (PI)

Description
A long, thin rectangle used to show % complete when reading big files, or running long calculations. Will accept a data variable (the current and target values) with the default target taken as 100. However a more common use is to update it from within a processing loop:

:For ct :in ¼todo
...
pb #.CPro.Do 'Set' (ct todo)
...
:EndFor

... which updates immediately. You could also set the Value variable here and use 1 #.CPro.Notify to get the same effect.

N.B. If you need Abort functionality, you should use the GuiPbar namespace instead:

#.GuiPbar.Open 'Please Wait'
#.GuiPbar.Set (ct todo)
…(1=#.GuiPbar.State)†Abort
#.GuiPbar.Close

This provides a standard ‘ontop’ progress tracker which you can use to check if the user hit the <Cancel> button.

Class Property Table

Name Type Default Description
Hint String
Value Runtime Progress to date (current,max)
Drawn OneOf Visual style (Continuous or blocky)
Format Text ‘? of #’ Message text (? done of total #, ~ to do)

Class-specific Functions

Set Explicit setting of amount completed
SetText Set new text to embed values in

Name	Type	Default	Description
Hint	String
Value	Runtime		Progress to date (current,max)
Drawn	OneOf		Visual style (Continuous or blocky)
Format	Text	‘? of #’	Message text (? done of total #, ~ to do)

Set	Explicit setting of amount completed
SetText	Set new text to embed values in