QueryCancelDocumentClose event

   Example   

Occurs before the application closes a document in response to a user action in the interface. If any event handler returns True, the operation is canceled.

Version added

2000

Syntax

Private Function object_QueryCancelDocumentClose(ByVal doc As IVDocument) As Boolean

Remarks

A Visio instance fires QueryCancelDocumentClose after the user has directed the instance to close a document.

• If any event handler returns True (cancel), the instance will fire DocumentCloseCanceled and not close the document.

• If all handlers return False (don't cancel), the instance will fire BeforeDocumentClose and then close the document.

While a Visio instance is firing a query or cancel event it will respond to inquiries from client code but will refuse to perform operations. Client code can show forms or message boxes while responding to a query or cancel event.

If you're using Microsoft Visual Basic or Visual Basic for Applications, 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.