SetProgressWindow()

Summary

Sets the title and the maximum number of progress bars that can be created in the progress window.

 

Syntax

SetProgressWindow(string title, integer max_bars [, array substition:values])

 

Argument	Contents
title	A formatted string displayed that appears as the title of the progress window; null to retain the previous setting
max_bars	The maximum number of progress bars that will be displayed in the window; a negative number to retain the previous setting
substitution_values	Optional. A list of values to be replaced in the activity string

 

Notes

• If max_bars is 0 then the progress window will not appear.

• The progress window is not actually displayed until CreateProgressBar() is called.

• SetProgressWindow() cannot change the maximum number of progress bars while progress bars are being displayed.

• Use ResetProgressWindow() to reset the maximum number of progress bars that can be created in the progress window to the number prior to the last call to SetProgressWindow().

• If the type of substitution values do not correspond to the formatting placeholders, the activity text will be blank.

• The ProgressBar Class provides methods that simplify the use of progress bars.

Example

SetProgressWindow("Status", 1)
CreateProgressBar("Finding %s", "True", {"Neighbors"})

loops = 1000000
for i = 1 to loops do
   stat = UpdateProgressBar("Step Number %i", r2i(i/loops), {i})
   if stat = "True" then do
       ShowMessage("You Quit!")
       goto quit_loop

   end

   // Do some processing here

   //...

   //...

end
quit_loop:
DestroyProgressBar()
ResetProgressWindow()

 

 

See Also

Function	Summary
CreateProgressBar()	Creates a new progress bar that reports the progress of an operation
DestroyProgressBar()	Destroys a progress bar, indicating completion of an operation
ResetProgressWindow()	Resets the title and the maximum number of progress bars that can be created in the progress window to the number prior to the last call to SetProgressWindow()
UpdateProgressBar()	Updates a progress bar in the progress window