Prev Next

EA_OnPreNewDiagram

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

The notification is provided immediately before the diagram is created, so that the Add-In can disable addition of the diagram.

Syntax

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

The EA_OnPreNewDiagram function syntax contains these parameters.

Parameter

Type

See also

Info

EA.EventProperties

Direction: IN

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

  • Type: A string value corresponding to Diagram.Type
  • ParentID: A long value corresponding to Diagram.ParentID
  • PackageID: A long value corresponding to Diagram.PackageID
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 new diagram to the model. Return False to disable addition of the new diagram.

Learn more