EA_OnPreNewDiagramObject

EA_OnPreNewDiagramObject notifies Add-Ins that a new diagram object is about to be dropped on a diagram. It enables Add-Ins to permit or deny creation of the new object.

This event occurs when a user drags an object from the Enterprise Architect Project Browser or Resources window onto a diagram. The notification is provided immediately before the object is created, so that the Add-In can disable addition of the object.

Syntax

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

The EA_OnPreNewDiagramObject function syntax contains these parameters.

Parameter

Type

See also

Info

EA.EventProperties

Direction: IN

Description: Contains these EventProperty objects for the object to be created:

  • Type: A string value corresponding to the Type of object being added to the diagram
  • Stereotype: A string value corresponding to the Stereotype of the object being added to the diagram
  • ID: A long value corresponding to the ID of the Element, Package or Diagram being added to the diagram
  • DiagramID: A long value corresponding to the ID of the diagram to which the object is being added

EventProperties Class

Repository

EA.Repository

Direction: IN

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

Repository Class

Return Value

Return True to enable addition of the object to the model. Return False to disable addition of the object.

Learn more