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)

 

Argument	Contents
title	The text 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

 

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().

Example

SetProgressWindow("Status", 1)     // Allow only a single progress bar

CreateProgressBar("Calculating...", "True")

for i = 1 to 100 do

     stat = UpdateProgressBar("Step Number " + String(i), i)

     if stat = "True" then do

          ShowMessage("You Quit!")

          goto quit_loop

          end

     x = x + i * i          // The meat of this loop

     end

quit_loop:

DestroyProgressBar()

ResetProgressWindow()    // Return to previous maximum number of progress bars

 

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