ShowProgress Property [Visio 2003 SDK Documentation]

  • Article

Determines whether a progress indicator is shown while performing certain operations.

intRet = object**.ShowProgress**

object**.ShowProgress** = intExpression

intRet     Integer. True (-1) if a progress indicator is showing; otherwise, False (0).

object     Required. An expression that returns an Application object.

intExpression     Required Integer. True (non-zero) to show a progress indicator; otherwise, False (0).

Version added

4.1

Remarks

If you want to perform an operation, such as printing, that typically displays a progress indicator but you don't want the progress indicator to appear, set the ShowProgress property to False (0). By default, the ShowProgress property is True (non-zero).

In most cases you should restore the setting to its prior value when you've completed the operation.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to use the ShowProgress property of the Application object. It toggles the display of the progress indicator on and off and displays the state of the property in the Immediate window.

Sub ShowProgress_Example()
 
    'Create a variable to hold the current state
    'of the progress indicator.
    Dim intProgress As Integer

    'Display the current state of the progress indicator. 
    Debug.Print "Initial state: " & Application.ShowProgress 

    'Get the state of the progress indicator. 
    intProgress = Application.ShowProgress 

    'Turn off the progress indicator. 
    Application.ShowProgress = False

    'Display the status again. 
    Debug.Print "Changed state: " & Application.ShowProgress 

    'Now restore the progress indicator to its original state. 
    Application.ShowProgress = intProgress 

    'Display the status again. 
    Debug.Print "Restored state: " & Application.ShowProgress 

End Sub

Applies to | Application object | InvisibleApp object

See Also | AlertResponse property