C# Class EAAddinFramework.EAAddinBase

EA_Connect events enable Add-Ins to identify their type and to respond to Enterprise Architect start up. This event occurs when Enterprise Architect first loads your Add-In. Enterprise Architect itself is loading at this time so that while a rep object is supplied, there is limited information that you can extract from it. The chief uses for EA_Connect are in initializing global Add-In data and for identifying the Add-In as an MDG Add-In. Also look at EA_Disconnect.

The EA_Disconnect event enables the Add-In to respond to user requests to disconnect the model branch from an external project. This function is called when the Enterprise Architect closes. If you have stored references to Enterprise Architect objects (not particularly recommended anyway), you must release them here. In addition, .NET users must call memory management functions as shown below: GC.Collect(); GC.WaitForPendingFinalizers(); Also look at EA_Connect.

The EA_FileClose event enables the Add-In to respond to a FileHistory Close event. When Enterprise Architect closes an opened Model file, this event is raised and passed to all Add-Ins implementing this method. This event occurs when the model currently opened within Enterprise Architect is about to be closed (when another model is about to be opened or when Enterprise Architect is about to shutdown). Also look at EA_FileOpen and EA_FileNew.

The EA_FileNew event enables the Add-In to respond to a FileHistory New event. When Enterprise Architect creates a new model file, this event is raised and passed to all Add-Ins implementing this method. The event occurs when the model being viewed by the Enterprise Architect user changes, for whatever reason (through user interaction or Add-In activity). Also look at EA_FileClose and EA_FileOpen.

The EA_FileOpen event enables the Add-In to respond to a FileHistory Open event. When Enterprise Architect opens a new model file, this event is raised and passed to all Add-Ins implementing this method. The event occurs when the model being viewed by the Enterprise Architect user changes, for whatever reason (through user interaction or Add-In activity). Also look at EA_FileClose and EA_FileNew.

This event occurs when Enterprise Architect is instructed to redraw an element. It requests that the Add-In provide the data to populate the element's compartment.

The EA_GetMenuItems event enables the Add-In to provide the Enterprise Architect user interface with additional Add-In menu options in various context and main menus. When a user selects an Add-In menu option, an event is raised and passed back to the Add-In that originally defined that menu option. This event is raised just before Enterprise Architect has to show particular menu options to the user, and its use is described in the Define Menu Items topic. Also look at: - EA_MenuClick - EA_GetMenuState.

The EA_GetMenuState event enables the Add-In to set a particular menu option to either enabled or disabled. This is useful when dealing with locked packages and other situations where it is convenient to show a menu option, but not enable it for use. This event is raised just before Enterprise Architect has to show particular menu options to the user. Its use is described in the Define Menu Items topic. Also look at EA_GetMenuItems.

EA_MenuClick events are received by an Add-In in response to user selection of a menu option. The event is raised when the user clicks on a particular menu option. When a user clicks on one of your non-parent menu options, your Add-In receives a MenuClick event, defined as follows: Sub EA_MenuClick(rep As EA.rep, ByVal MenuName As String, ByVal ItemName As String) Notice that your code can directly access Enterprise Architect data and UI elements using rep methods. Also look at EA_GetMenuItems.

EA_OnContextItemChanged notifies Add-Ins that a different item is now in context. This event occurs after a user has selected an item anywhere in the Enterprise Architect GUI. Add-Ins that require knowledge of the current item in context can subscribe to this broadcast function. If objectType = otRepository, then this function behaves the same as EA_FileOpen. Also look at EA_OnContextItemDoubleClicked and EA_OnNotifyContextItemModified.

EA_OnContextItemDoubleClicked notifies Add-Ins that the user has double-clicked the item currently in context. This event occurs when a user has double-clicked (or pressed [Enter]) on the item in context, either in a diagram or in the Project Browser. Add-Ins to handle events can subscribe to this broadcast function. Also look at EA_OnContextItemChanged and EA_OnNotifyContextItemModified.

EA_OnEndValidation notifies Add-Ins that model validation has completed. Use this event to arrange any clean-up operations arising from the validation.

EA_OnInitializeTechnologies requests that an Add-In pass an MDG Technology to Enterprise Architect for loading. This event occurs on Enterprise Architect startup. Return your technology XML to this function and Enterprise Architect loads and enables it.

EA_OnInitializeUserRules is called on Enterprise Architect start-up and requests that the Add-In provide Enterprise Architect with a rule category and list of rule IDs for model validation. This function must be implemented by any Add-In that is to perform its own model validation. It must call Project.DefineRuleCategory once and Project.DefineRule for each rule; these functions are described in the Project Interface section.

EA_OnNotifyContextItemModified notifies Add-Ins that the current context item has been modified. This event occurs when a user has modified the context item. Add-Ins that require knowledge of when an item has been modified can subscribe to this broadcast function. Also look at EA_OnContextItemChanged and EA_OnContextItemDoubleClicked.

EA_OnOutputItemClicked events inform Add-Ins that the user has clicked on a list entry in the system tab or one of the user defined output tabs. Usually an Add-In responds to this event in order to capture activity on an output tab they had previously created through a call to rep.AddTab(). Note that every loaded Add-In receives this event for every click on an output tab in Enterprise Architect - irrespective of whether the Add-In created that tab. Add-Ins should therefore check the TabName parameter supplied by this event to ensure that they are not responding to other Add-Ins' events. Also look at EA_OnOutputItemDoubleClicked.

EA_OnOutputItemDoubleClicked events informs Add-Ins that the user has used the mouse to double-click on a list entry in one of the user-defined output tabs. Usually an Add-In responds to this event in order to capture activity on an output tab they had previously created through a call to rep.AddTab(). Note that every loaded Add-In receives this event for every double-click on an output tab in Enterprise Architect - irrespective of whether the Add-In created that tab. Add-Ins should therefore check the TabName parameter supplied by this event to ensure that they are not responding to other Add-Ins' events. Also look at EA_OnOutputItemClicked.

EA_OnPostActivateTechnology notifies Add-Ins that an MDG Technology resource has been activated in the model. This event occurs when a user activates an MDG Technology resource in the model (by clicking on the Set Active button on the MDG Technologies dialog or by selecting the technology in the list box in the Default Tools toolbar). The notification is provided immediately after the user succeeds in activating the MDG Technology, so that the Add-In can update the Technology if necessary. Also look at EA_OnPreActivateTechnology.

EA_OnPostCloseDiagram notifies Add-Ins that a diagram has been closed. Also look at EA_OnPostOpenDiagram.

EA_OnPostInitialized notifies Add-Ins that the rep object has finished loading and any necessary initialization steps can now be performed on the object. For example, the Add-In can create an Output tab using rep.CreateOutputTab.

EA_OnPostNewAttribute notifies Add-Ins that a new attribute has been created on a diagram. It enables Add-Ins to modify the attribute upon creation. This event occurs when a user creates a new attribute on an element by either drag-dropping from the Project Browser, using the Attributes Properties dialog, or using the in-place editor on the diagram. The notification is provided immediately after the attribute is created. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewAttribute.

EA_OnPostNewConnector notifies Add-Ins that a new connector has been created on a diagram. It enables Add-Ins to modify the connector upon creation. This event occurs after a user has dragged a new connector from the Toolbox or Resources window onto a diagram. The notification is provided immediately after the connector is added to the model. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewConnector.

EA_OnPostNewDiagram notifies Add-Ins that a new diagram has been created. It enables Add-Ins to modify the diagram upon creation. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewDiagram.

EA_OnPostNewDiagramObject notifies Add-Ins that a new object has been created on a diagram. It enables Add-Ins to modify the object upon creation. This event occurs after a user has dragged a new object from the Project Browser or Resources window onto a diagram. The notification is provided immediately after the object is added to the diagram. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewDiagramObject.

EA_OnPostNewElement notifies Add-Ins that a new element has been created on a diagram. It enables Add-Ins to modify the element upon creation. This event occurs after a user has dragged a new element from the Toolbox or Resources window onto a diagram. The notification is provided immediately after the element is added to the model. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewElement.

EA_OnPostNewGlossaryTerm notifies Add-Ins that a new glossary term has been created. It enables Add-Ins to modify the glossary term upon creation. The notification is provided immediately after the glossary term is added to the model. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewGlossaryTerm.

EA_OnPostNewMethod notifies Add-Ins that a new method has been created on a diagram. It enables Add-Ins to modify the method upon creation. This event occurs when a user creates a new method on an element by either drag-dropping from the Project Browser, using the method's Properties dialog, or using the in-place editor on the diagram. The notification is provided immediately after the method is created. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewMethod.

EA_OnPostNewPackage notifies Add-Ins that a new package has been created on a diagram. It enables Add-Ins to modify the package upon creation. 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. Set rep.SuppressEADialogs to true to suppress Enterprise Architect from showing its default dialogs. Also look at EA_OnPreNewPackage.

EA_OnPostOpenDiagram notifies Add-Ins that a diagram has been opened. Also look at EA_OnPostCloseDiagram.

EA_OnPostTransform notifies Add-Ins that an MDG transformation has taken place with the output in the specified target package. This event occurs when a user runs an MDG transform on one or more target packages. The notification is provided for each transform/target package immediately after all transform processes have completed.

EA_OnPreActivateTechnology notifies Add-Ins that an MDG Technology resource is about to be activated in the model. This event occurs when a user selects to activate an MDG Technology resource in the model (by clicking on the Set Active button on the MDG Technologies dialog or by selecting the technology in the list box in the Default Tools toolbar). The notification is provided immediately after the user attempts to activate the MDG Technology, so that the Add-In can permit or disable activation of the Technology. Also look at EA_OnPostActivateTechnology.

EA_OnPreDeleteAttribute notifies Add-Ins that an attribute is to be deleted from the model. It enables Add-Ins to permit or deny deletion of the attribute. This event occurs when a user deletes an attribute from the Project Browser or on a diagram. The notification is provided immediately before the attribute is deleted, so that the Add-In can disable deletion of the attribute.

EA_OnPreDeleteConnector notifies Add-Ins that an connector is to be deleted from the model. It enables Add-Ins to permit or deny deletion of the connector. This event occurs when a user attempts to permanently delete a connector on a diagram. The notification is provided immediately before the connector is deleted, so that the Add-In can disable deletion of the connector.

EA_OnPreDeleteDiagram notifies Add-Ins that an diagram is to be deleted from the model. It enables Add-Ins to permit or deny deletion of the diagram. This event occurs when a user attempts to permanently delete a diagram from the Project Browser. The notification is provided immediately before the diagram is deleted, so that the Add-In can disable deletion of the diagram.

EA_OnPreDeleteElement notifies Add-Ins that an element is to be deleted from the model. It enables Add-Ins to permit or deny deletion of the element. This event occurs when a user deletes an element from the Project Browser or on a diagram. The notification is provided immediately before the element is deleted, so that the Add-In can disable deletion of the element.

EA_OnPreDeleteGlossaryTerm notifies Add-Ins that a glossary term is to be deleted from the model. It enables Add-Ins to permit or deny deletion of the glossary term. The notification is provided immediately before the glossary term is deleted, so that the Add-In can disable deletion of the glossary term.

EA_OnPreDeleteMethod notifies Add-Ins that an method is to be deleted from the model. It enables Add-Ins to permit or deny deletion of the method. This event occurs when a user deletes an method from the Project Browser or on a diagram. The notification is provided immediately before the method is deleted, so that the Add-In can disable deletion of the method.

EA_OnPreDeletePackage notifies Add-Ins that an package is to be deleted from the model. It enables Add-Ins to permit or deny deletion of the package. This event occurs when a user attempts to permanently delete a package from the Project Browser. The notification is provided immediately before the package is deleted, so that the Add-In can disable deletion of the package.

EA_OnPreExitInstance is not currently used.

EA_OnPreNewAttribute notifies Add-Ins that a new attribute is about to be created on an element. It enables Add-Ins to permit or deny creation of the new attribute. This event occurs when a user creates a new attribute on an element by either drag-dropping from the Project Browser, using the Attributes Properties dialog, or using the in-place editor on the diagram. The notification is provided immediately before the attribute is created, so that the Add-In can disable addition of the attribute. Also look at EA_OnPostNewAttribute.

EA_OnPreNewConnector notifies Add-Ins that a new connector is about to be created on a diagram. It enables Add-Ins to permit or deny creation of a new connector. This event occurs when a user drags a new connector from the Toolbox or Resources window, onto a diagram. The notification is provided immediately before the connector is created, so that the Add-In can disable addition of the connector. Also look at EA_OnPostNewConnector.

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.

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. Also look at EA_OnPostNewDiagramObject.

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 creation of the new element. This event occurs when a user drags a new element from the Toolbox or Resources window onto a diagram. The notification is provided immediately before the element is created, so that the Add-In can disable addition of the element. Also look at EA_OnPostNewElement.

EA_OnPreNewGlossaryTerm notifies Add-Ins that a new glossary term is about to be created. It enables Add-Ins to permit or deny creation of the new glossary term. The notification is provided immediately before the glossary term is created, so that the Add-In can disable addition of the element. Also look at EA_OnPostNewGlossaryTerm.

EA_OnPreNewMethod notifies Add-Ins that a new method is about to be created on an element. It enables Add-Ins to permit or deny creation of the new method. This event occurs when a user creates a new method on an element by either drag-dropping from the Project Browser, using the method Properties dialog, or using the in-place editor on the diagram. The notification is provided immediately before the method is created, so that the Add-In can disable addition of the method. Also look at EA_OnPostNewMethod.

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.

EA_OnRetrieveModelTemplate requests that an Add-In pass a model template to Enterprise Architect. This event occurs when a user executes the Add a New Model Using Wizard command to add a model that has been defined by an MDG Technology. See the Incorporate Model Templates topic for details of how to define such model templates.

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each attribute in the selection being validated. If you don't want to perform the rule defined by RuleID on the given attribute, then simply return without performing any action. On performing any validation, if a validation error is found, use the rep.ProjectInterface.PublishResult method to notify Enterprise Architect.

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each connector in the selection being validated. If you don't want to perform the rule defined by RuleID on the given connector, then simply return without performing any action. On performing any validation, if a validation error is found, use the rep.ProjectInterface.PublishResult method to notify Enterprise Architect.

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each diagram in the selection being validated. If you don't want to perform the rule defined by RuleID on the given diagram, then simply return without performing any action. On performing any validation, if a validation error is found, use the rep.ProjectInterface.PublishResult method to notify Enterprise Architect.

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each element in the selection being validated. If you don't want to perform the rule defined by RuleID on the given element, then simply return without performing any action. On performing any validation, if a validation error is found, use the rep.ProjectInterface.PublishResult method to notify Enterprise Architect. Also look at EA_OnInitializeUserRules.

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each method in the selection being validated. If you don't want to perform the rule defined by RuleID on the given method, then simply return without performing any action. On performing any validation, if a validation error is found, use the rep.ProjectInterface.PublishResult method to notify Enterprise Architect.

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each package in the selection being validated. If you don't want to perform the rule defined by RuleID on the given package, then simply return without performing any action. On performing any validation, if a validation error is found, use the rep.ProjectInterface.PublishResult method to notify Enterprise Architect.

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each parameter in the selection being validated. If you don't want to perform the rule defined by RuleID on the given parameter, then simply return without performing any action. On performing any validation, if a validation error is found, use the rep.ProjectInterface.PublishResult parameter to notify Enterprise Architect.

EA_OnStartValidation notifies Add-Ins that a user has invoked the model validation command from Enterprise Architect.

This event occurs when Enterprise Architect's diagrams are refreshed. It is a request for the Add-In to provide a list of user-defined compartments. The EA_GetCompartmentData event then queries each object for the data to display in each user-defined compartment.

The EA_ShowHelp event enables the Add-In to show a help topic for a particular menu option. When the user has an Add-In menu option selected, pressing [F1] can be delegated to the required Help topic by the Add-In and a suitable help message shown. This event is raised when the user presses [F1] on a menu option that is not a parent menu. Also look at EA_GetMenuItems.

MDG_BuildProject enables the Add-In to handle file changes caused by generation. This function is called in response to a user selecting the Add-Ins | Build Project menu option. Respond to this event by compiling the project source files into a running application. Also look at MDG_RunExe.

MDG_Connect enables the Add-In to handle user driven request to connect a model branch to an external application. This function is called when the user attempts to connect a particular Enterprise Architect package to an as yet unspecified external project. This event enables the Add-In to interact with the user to specify such a project. The Add-In is responsible for retaining the connection details, which should be stored on a per-user or per-workstation basis. That is, users who share a common Enterprise Architect model over a network should be able to connect and disconnect to external projects independently of one another. The Add-In should therefore not store connection details in an Enterprise Architect rep. A suitable place to store such details would be: SHGetFolderPath(..CSIDL_APPDATA..)\AddinName. The PackageGuid parameter is the same identifier as required for most events relating to the MDG Add-In. Therefore it is recommended that the connection details be indexed using the PackageGuid value. The PackageID parameter is provided to aid fast retrieval of package details from Enterprise Architect, should this be required. Also look at MDG_Disconnect.

MDG_Disconnect enables the Add-In to respond to user requests to disconnect the model branch from an external project. This function is called when the user attempts to disconnect an associated external project. The Add-In is required to delete the details of the connection. Also look at MDG_Connect.

MDG_GetConnectedPackages enables the Add-In to return a list of current connection between Enterprise Architect and an external application. This function is called when the Add-In is first loaded, and is expected to return a list of the available connections to external projects for this Add-In. Also look at MDG_Connect

MDG_GetProperty provides miscellaneous Add-In details to Enterprise Architect. This function is called by Enterprise Architect to poll the Add-In for information relating to the PropertyName. This event should occur in as short a duration as possible as Enterprise Architect does not cache the information provided by the function. Values corresponding to the following PropertyNames must be provided: - IconID - Return the name of a DLL and a resource identifier in the format #ResID, where the resource ID indicates an Icon; for example, c:\program files\myapp\myapp.dlll#101 - Language - Return the default language that Classes should be assigned when they are created in Enterprise Architect - HiddenMenus - Return one or more values from the MDGMenus enumeration to hide menus that do not apply to your Add-In. For example: if( PropertyName == "HiddenMenus" ) return mgBuildProject + mgRun;

MDG_Merge enables the Add-In to jointly handle changes to both the model branch and the code project that the model branch is connected to. This event should be called whenever the user has asked to merge their model branch with its connected code project, or whenever the user has established a new connection to a code project. The purpose of this event is to enable the Add-In to interact with the user to perform a merge between the model branch and the connected project. Also look at MDG_Connect, MDG_PreMerge and MDG_PostMerge. Merge A merge consists of three major operations: - Export: Where newly created model objects are exported into code and made available to the code project. - Import: Where newly created code objects, Classes and such things are imported into the model. - Synchronize: Where objects available both to the model and in code are jointly updated to reflect changes made in either the model, code project or both. - Synchronize Type The Synchronize operation can take place in one of four different ways. Each of these ways corresponds to a value returned by SynchType: - None: (SynchType = 0) No synchronization is to be performed - Forward: (SynchType = 1) Forward synchronization, between the model branch and the code project is to occur - Reverse: (SynchType = 2) Reverse synchronization, between the code project and the model branch is to occur - Both: (SynchType = 3) Reverse, then Forward synchronization's are to occur. Object ID Format Each of the Object IDs listed in the string arrays described above should be composed in the following format: (@namespace)*(#class)*($attribute|%operation|:property)*

MDG_NewClass enables the Add-In to alter details of a Class before it is created. This method is called when Enterprise Architect generates a new Class, and requires information relating to assigning the language and file path. The file path should be passed back as a return value and the language should be passed back via the language parameter. Also look at MDG_PreGenerate

MDG_PostGenerate enables the Add-In to handle file changes caused by generation. This event is called after Enterprise Architect has prepared text to replace the existing contents of a file. Responding to this event enables the Add-In to write to the linked application's user interface rather than modify the file directly. When the contents of a file are changed, Enterprise Architect passes FileContents as a non-empty string. New files created as a result of code generation are also sent through this mechanism, enabling Add-Ins to add new files to the linked project's file list. When new files are created Enterprise Architect passes FileContents as an empty string. When a non-zero is returned by this function, the Add-In has successfully written the contents of the file. A zero value for the return indicates to Enterprise Architect that the file must be saved. Also look at MDG_PreGenerate.

MDG_PostMerge is called after a merge process has been completed. This function is called by Enterprise Architect after the merge process has been completed. Note: FileHistory save checking should not be performed with this function, but should be handled by MDG_PreGenerate, MDG_PostGenerate and MDG_PreReverse. Also look at MDG_PreMerge and MDG_Merge.

MDG_PreGenerate enables the Add-In to deal with unsaved changes. This function is called immediately before Enterprise Architect attempts to generate files from the model. A possible use of this function would be to prompt the user to save unsaved source files. Also look at MDG_PostGenerate.

MDG_PreMerge is called after a merge process has been initiated by the user and before Enterprise Architect performs the merge process. This event is called after a user has performed their interactions with the merge screen and has confirmed the merge with the OK button, but before Enterprise Architect performs the merge process using the data provided by the MDG_Merge call, before any changes have been made to the model or the connected project. This event is made available to provide the Add-In with the opportunity to generally set internal Add-In flags to augment the MDG_PreGenerate, MDG_PostGenerate and MDG_PreReverse events. Note: FileHistory save checking should not be performed with this function, but should be handled by MDG_PreGenerate, MDG_PostGenerate and MDG_PreReverse. Also look at MDG_Merge and MDG_PostMerge.

MDG_PreReverse enables the Add-In to save file changes before being imported into Enterprise Architect. This function operates on a list of files that are about to be reverse-engineered into Enterprise Architect. If the user is working on unsaved versions of these files in an editor, you could either prompt the user or save automatically. Also look at MDG_PostGenerate and MDG_PreGenerate.

MDG_RunExe enables the Add-In to run the target application. This function is called when the user selects the Add-Ins | Run Exe menu option. Respond to this event by launching the compiled application. Also look at MDG_BuildProject.

MDG_View enables the Add-In to display user specified code elements. This function is called by Enterprise Architect when the user asks to view a particular code element. This enables the Add-In to present that element in its own way, usually in a code editor.

returns true if a project is currently opened