ShowProgressBar

(not documented prior to 4.0)

Declaration

ShowProgressBar(title,text:Text atomic; p:number atomic)

Description

Displays or updates a programmable dialog containing a progress bar. The first time it is called with p<1, the dialog appears. When 0<=p<1, a Cancel button is displayed and the progress meter is updated to the indicated proportion, allowing computation to continue while it is visible. If the user presses Cancel, the computation is aborted. When p=1, an OK button is shown and the dialog waits until OK is pressed to return and then disappears. The dialog is also removed when p>1 or a computation completes.

Example

var xOrig := X;
var result := 
  for n[] := @Scenario do (
      ShowProgressBar( "Progress", "Computing Across All Scenarios", (n-1)/size(scenario) );
      WhatIf( Y, X, xOrig[@Scenario=n] )
  );
ShowProgressBar( "Progress", "Done", 1 );
result