EA_OnPreNewElement

Return to Introduction  Previous page  Next page

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

 

Syntax

 

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

 

The EA_OnPreNewElement 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 element to be created :

 

·Type : A string value corresponding to Element.Type
·Stereotype : A string value corresponding to Element.Stereotype
·ParentID : A long value corresponding to Element.ParentID
·DiagramID : A long value corresponding to the ID of the diagram to which the element is being added

 

 

Return Value

 

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

 

Details

 

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

See Also