EA_OnPreNewPackage

Details

EA_OnPreNewPackage notifies Add-Ins that a new package is about to be created in the model. It enables Add-Ins to permit or deny creation of the new package.

This event occurs when a user drags a new package from the Toolbox or Resources window onto a diagram, or by selecting the New Package icon from the Project Browser. The notification is provided immediately before the package is created, so that the Add-In can disable addition of the package.

Also look at EA_OnPostNewPackage.

Syntax

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

The EA_OnPreNewPackage function syntax contains the following elements:

Parameter

Type

Direction

Description

Info

EA.EventProperties

IN

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

  • Stereotype: A string value corresponding to Package.Stereotype
  • ParentID: A long value corresponding to Package.ParentID
  • DiagramID: A long value corresponding to the ID of the diagram to which the package is being added.

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 package to the model. Return False to disable addition of the new package.