EA_OnPreNewConnector

Return to Introduction  Previous page  Next page

EA_OnPreNewConnector notifies Add-Ins that a new connector is about to be created on a diagram. It enables Add-Ins to permit or deny the creation of new connector.

 

Syntax

 

Function EA_OnPreNewConnector(Repository As EA.Repository, Info As EA.EventProperties) As Boolean

 

The EA_OnPreNewConnector function syntax contains the following elements

 

 

Parameter

Type

Direction

Description

Repository

EA.Repository

 

IN

An EA.Repository object representing the currently open Enterprise Architect model. Poll its members to retrieve model data and user interface status information.

Info

EA.EventProperties

IN

Contains the following EventProperty Objects for the connector to be created :

 

·Type : A string value corresponding to Connector.Type
·Subtype : A string value corresponding to Connector.Subtype
·Stereotype : A string value corresponding to Connector.Stereotype
·ClientID : A long value corresponding to Connector.ClientID
·SupplierID : A long value corresponding to Connector.SupplierID

DiagramID : A long value corresponding to Connector.DiagramID

 

Return Value

 

Return True to enable the addition of the new connector to the model. Return False to disenable the addition of the new connector.

 

Details

 

This event occurs when a user drags a new connector from the UML toolbox or Resource Tree, onto a diagram. The notification is provided immediately before the connector is created, so that the Add-In can disenable the addition of the connector.

See Also