QueryCancelConvertToGroup event

Microsoft Visio Developer Reference

QueryCancelConvertToGroup event

   Example   

Occurs before the application converts a selection of shapes to a group 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_QueryCancelConvertToGroup(ByVal Selection As IVSelection) As Boolean

object

The WithEvents object that receives the event.

return value

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

Remarks

A Visio instance fires QueryCancelConvertToGroup after the user has directed the instance to convert one or more shapes into groups.

  • If any event handler returns True (cancel), the instance will fire ConvertToGroupCanceled and not convert the shapes.
  • If all handlers return False (don't cancel), the conversion will be performed.

In some cases, such as when a shape with a ForeignType property of visTypeMetafile is converted to a group, the initial shape will be deleted and replaced with new shapes. In such cases the Visio instance will subsequently fire BeforeSelectionDelete and BeforeShapeDelete events before converting 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, 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.