Share via


Documents.QueryCancelUngroup Event

Visio Automation Reference

Occurs before the application ungroups a selection of shapes in response to a user action in the interface. If any event handler returns True, the operation is canceled.

Version Information
 Version Added:  Visio 2000

Syntax

Private Sub expression_QueryCancelUngroup(ByVal Selection As [IVSELECTION])

expression   A variable that represents a Documents object.

Parameters

Name Required/Optional Data Type Description
Selection Required [IVSELECTION] The selection of shapes that is going to be ungrouped.

Remarks

A Microsoft Office Visio instance fires QueryCancelUngroup after the user has directed the instance to ungroup one or more shapes.

  • If any event handler returns True (cancel), the instance will fire UngroupCanceled and not ungroup the shapes.
  • If all handlers return False (don't cancel), the instance will fire ShapeParentChanged, BeforeSelectionDelete, and BeforeShapeDelete, and then ungroup the shapes.

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.

See Also