Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

EA_OnPreNewDiagram

Details

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.

Also look at EA_OnPostNewDiagram.

Syntax

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

The EA_OnPreNewDiagram function syntax contains the following elements:

Parameter

Type

Direction

Description

Info

EA.EventProperties

IN

Contains the following 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.

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.

Return Value

Return True to enable addition of the new diagram to the model. Return False to disable addition of the new diagram.