Share via

Application.ExitScope Event

  • Article
Visio Automation Reference

Queued when an internal command ends, or when an Automation client exits a scope by using the EndUndoScope method.

Version Information
 Version Added:  Visio 2000

Syntax

Private Sub expression_ExitScope(ByVal app As [IVAPPLICATION], ByVal nScopeID As Long, ByVal bstrDescription As String, ByVal bErrOrCancelled As Boolean)

expression   A variable that represents an Application object.

Parameters

Name Required/Optional Data Type Description
app Required [IVAPPLICATION] The instance of Microsoft Office Visio that contains the scope.
nScopeID Required Long A language-independent number that describes the operation that just ended, or the scope ID returned by the BeginUndoScope method.
bstrDescription Required String A textual description of the operation that changes in different language versions. Contains the UI description of a Visio operation or the description passed to the BeginUndoScope method.
bErrOrCancelled Required Boolean True if there was an error during the scope or if the scope was canceled; False if there wasn't an error and it wasn't canceled.

Remarks

The nScopeID value returned in the case of a Visio operation is the equivalent of the command related constants that begin with visCmd*.

If you are using Microsoft Visual Basic or Visual Basic for Applications (VBA), the syntax in this topic describes a common, efficient way to handle events.

If you want to create your own Event objects, use the Add or AddAdvise method. To create an Event object that runs an add-on, use the Add method as it applies to the EventList collection. To create an Event object that receives notification, use the AddAdvise method. To find an event code for the event you want to create, see Event codes.

If you are handling this event from a program that receives a notification over a connection created using the AddAdvise method, the ExitScope event is one of a group of selected events that record extra information in the EventInfo property of the Application object.

The EventInfo property returns bstrDescription, as described previously. In addition, the varMoreInfo argument to VisEventProc contains a string formatted as follows: [<nScopeID>;<bErrOrCancelled>;<bstrDescription>;<nHwndContext>], where nHwndContext is the window handle (HWND) of the window that is the context for the command. nHwndContext could be 0.

For ExitScope, bErrOrCancelled is non-zero if the operation failed or was canceled.

Example

This example shows how to use the ExitScope event. The example determines whether a call to a procedure that handles the CellChanged event is in a particular scope—that is, whether the call occurs between the EnterScope and ExitScope events for that scope.

Visual Basic for Applications 
  
Private WithEvents vsoApplication As Visio.Application 
Private lngScopeID AsLong

Public Sub Scope_Example()


Dim vsoShape As Visio.Shape 

'Set the module-level application variable to
'trap application-level events.
Set vsoApplication = Application

'Begin a scope. 
lngScopeID = Application.BeginUndoScope("Draw Shapes") 

'Draw three shapes.
Set vsoShape = ActivePage.DrawRectangle(1, 2, 2, 1) 
ActivePage.DrawOval 3, 4, 4, 3 
ActivePage.DrawLine 4, 5, 5, 4 

'Change a cell (to trigger a CellChanged event). 
vsoShape.Cells("Width").Formula = 5 

'End and commit this scope. 
Application.EndUndoScope lngScopeID, True



End Sub


Private Sub vsoApplication_CellChanged(ByVal Cell As IVCell)


'Check to see if this cell change is the result of something
'happening within the scope.
If vsoApplication.IsInScope(lngScopeID) Then 
    Debug.Print Cell.Name &amp; " changed in scope "; lngScopeID 
End If  



End Sub


Private Sub vsoApplication_EnterScope(ByVal app As IVApplication, _
ByVal nScopeID As Long, _
ByVal bstrDescription As String)


If vsoApplication.CurrentScope = lngScopeID Then 
    Debug.Print "Entering my scope " &amp; nScopeID 
Else 
    Debug.Print "Enter Scope " &amp; bstrDescription &amp; "(" &amp; nScopeID &amp; ")" 
End If  



End Sub


Private Sub vsoApplication_ExitScope(ByVal app As IVApplication, _
ByVal nScopeID As Long, _
ByVal bstrDescription As String, _
ByVal bErrOrCancelled As Boolean)


If vsoApplication.CurrentScope = lngScopeID Then 
    Debug.Print "Exiting my scope " &amp; nScopeID 
Else 
    Debug.Print "Exit Scope " &amp; bstrDescription &amp; "(" &amp; nScopeID &amp; ")" 
End If  



End Sub

See Also