IDLitIMessaging::ProgressBar

Syntax | Return Value | Arguments | Keywords | Version History

The IDLitIMessaging::ProgressBar function method is used to display a progress bar to the user and update the displayed values.

On the initial call to this method, a dialog is displayed. The dialog remains active until the method is called with the /SHUTDOWN keyword.

The actual method used to display the message to the user depends on the user interface in use. Normally, the progress bar is displayed as a modal dialog.

Syntax

Result = Obj->[IDLitIMessaging::]ProgressBar(StrMessage [, CANCEL=string] [, PERCENT=value] [, /SHUTDOWN])

Return Value

Returns 1 if the progress bar was displayed successfully, or 0 otherwise.

Arguments

StrMessage

A scalar string or string array containing a description of the action taking place.

Keywords

CANCEL

Set this keyword to a string containing the text for the Cancel button on the Progress Bar. If this keyword is not specified, or is set to a null string, then the string "Cancel" is used.

PERCENT

Set this keyword to a value between 0 and 100 that represents the "percentage complete" value to be shown on the progress bar.

SHUTDOWN

If set, any progress bar that is being displayed is removed from the user interface.

Version History