Share via

QueryCancelDocumentClose Event [Visio 2003 SDK Documentation]

  • Article

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.

Private Functionobject_QueryCancelDocumentClose(ByVal doc As IVDocument) As Boolean

object     The WithEvents object that receives the event.

return value     False to allow the operation; True to cancel the operation.

Version added

2000

Remarks

A Microsoft Office 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 (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.

Applies to | Application object | Document object | Documents collection | InvisibleApp object

See Also | Action property | AddAdvise method | BeforeDocumentClose event | DocumentCloseCanceled event