C# Class TSF.UmlToolingFramework.EANavigator.EAAddin

Inheritance: EAAddinFramework.EAAddinBase

Mostra file Open project: GeertBellekens/Enterprise-Architect-Toolpack Class Usage Examples

Private Properties

Property	Type	Description
FqnButtonClick	void
GuidButtonClick	void
NavigatorTreeBeforeExpand	void
NavigatorTreeNodeDoubleClick	void
filterMenuOptions	void
getActions	List
getAssociationClass	List
getAttributes	List
getClassifier	List
getCompositeDiagram	List
getCompositeElements	List
getConveyedElements	List
getConveyingConnectors	List
getDependentTaggedValues	List
getDepentDiagrams	List
getDiagramOperations	List
getDiagrams	List
getElementsViaTaggedValues	List
getImplementation	List
getImplementedOperation	List
getLinkedToElementFeatures	List
getMenuOptions	List
getOperation	List
getOwner	List
getOwnerMenuName	string
getParameterTypes	List
getParameters	List
getRelatedAssociation	List
getSelectedOperation	TSF.UmlToolingFramework.UML.Classes.Kernel.Operation
getTaggedValueMenuItems	List
getTypeMenuName	string
isGUIDString	bool
looksLikeFQN	bool
navigate	void
navigate	void
openInNavigatorClick	void
quickSearchTextChanged	void
selectFQN	void
selectFQN	void
selectGUID	void
selectGUID	void
taggedValueMenuName	string

Public Methods

Method	Description
EAAddin ( ) : System
EA_FileClose ( EA Repository ) : void
EA_FileOpen ( EA Repository ) : void
EA_GetMenuItems ( EA Repository, string MenuLocation, string MenuName ) : object	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.
EA_MenuClick ( global Repository, String Location, String MenuName, String ItemName ) : void	Execute the actual functions
EA_OnContextItemChanged ( global Repository, string GUID, global ot ) : void	the EA hook we use to show the selected element in the Navigator window
EA_OnPostInitialized ( EA Repository ) : void
EA_OnPostOpenDiagram ( EA Repository, int DiagramID ) : void
getElementsToNavigate ( string menuChoice, TSF.UmlToolingFramework.UML parentElement ) : List	returns the items to navigate based on the given element and chosen option.
quickSearch ( string searchText ) : void

Private Methods

Method	Description
FqnButtonClick ( object sender, EventArgs e ) : void	reacts to the event that the FQN button is clicked in the EA NavigatorControl
GuidButtonClick ( object sender, EventArgs e ) : void	reacts to the event that the GUID button is clicked in the EA NavigatorControl
NavigatorTreeBeforeExpand ( object sender, System.Windows.Forms.TreeViewCancelEventArgs e ) : void	gets the elements of a package right before expanding
NavigatorTreeNodeDoubleClick ( object sender, TreeNodeMouseClickEventArgs e ) : void	When a diagram is doubleclicked we need to set it a the main element
filterMenuOptions ( List menuOptionsList ) : void
getActions ( TSF.UmlToolingFramework.UML parentElement ) : List	opens the CallOperationActions that call te selected operation
getAssociationClass ( TSF.UmlToolingFramework.UML parentElement ) : List	gets the AssociationClass for the given association
getAttributes ( TSF.UmlToolingFramework.UML parentElement ) : List	Opens the attributes of that use the selected element as type
getClassifier ( TSF.UmlToolingFramework.UML parentElement ) : List	Opens the type of the attribute
getCompositeDiagram ( TSF.UmlToolingFramework.UML parentElement ) : List
getCompositeElements ( TSF.UmlToolingFramework.UML parentElement ) : List
getConveyedElements ( TSF.UmlToolingFramework.UML parentElement ) : List	returnst he elements conveyed by the given connector
getConveyingConnectors ( TSF.UmlToolingFramework.UML parentElement ) : List	returns the conveying connectors for the given classifier
getDependentTaggedValues ( TSF.UmlToolingFramework.UML parentItem ) : List	returns all tagged values that reference the given item
getDepentDiagrams ( TSF.UmlToolingFramework.UML parentElement ) : List	returns all diagrams that show this item
getDiagramOperations ( TSF.UmlToolingFramework.UML parentElement ) : List	returns all operations called on the given diagram
getDiagrams ( TSF.UmlToolingFramework.UML parentElement ) : List	get all using diagrams for the given element currently only used for operations
getElementsViaTaggedValues ( TSF.UmlToolingFramework.UML parentElement, string menuOption ) : List	returns all elements referenced by the tagged values of the parent element
getImplementation ( TSF.UmlToolingFramework.UML parentElement ) : List	selects the implementation of the operation in the project browser, and opens all owned diagrams of the implementation.
getImplementedOperation ( TSF.UmlToolingFramework.UML parentElement ) : List	returns the operation implemented by the given parentElement, or in case the parentElement is a diagram, by the owner of the parentElement
getLinkedToElementFeatures ( TSF.UmlToolingFramework.UML parentItem ) : List	returns all elements linked via the "link to element feature"
getMenuOptions ( TSF.UmlToolingFramework.UML element ) : List	returns the options depending on the type of the element
getOperation ( TSF.UmlToolingFramework.UML parentElement ) : List	gets the operation for the parent element which can be - an operation itself - a message calling the operation - a parameter for an operation - a CallOperationAction
getOwner ( TSF.UmlToolingFramework.UML parentElement ) : List	returns the owner of the parentElement
getOwnerMenuName ( TSF.UmlToolingFramework.UML element ) : string
getParameterTypes ( TSF.UmlToolingFramework.UML parentElement ) : List	Opens the types of the parameters of the selected operation
getParameters ( TSF.UmlToolingFramework.UML parentElement ) : List	Opens the parameters that use the selected element as type
getRelatedAssociation ( TSF.UmlToolingFramework.UML parentElement ) : List	gets the related Association for an AssociationClass
getSelectedOperation ( TSF.UmlToolingFramework.UML parentElement ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Operation	Gets the selected operation from the model, either directly or through the selected message
getTaggedValueMenuItems ( TSF.UmlToolingFramework.UML ownerElement ) : List	creates a list of menuoptions based on the names of tagged values that reference another UML item
getTypeMenuName ( TSF.UmlToolingFramework.UML element ) : string
isGUIDString ( string guidString ) : bool	returns true if the given string is a valid GUID format
looksLikeFQN ( string fqnCandidate ) : bool	does a basic check to verify that the given string sort of resembles an FQN sttring
navigate ( ) : void
navigate ( TSF.UmlToolingFramework.UML item ) : void
openInNavigatorClick ( object sender, EventArgs e ) : void
quickSearchTextChanged ( object sender, EventArgs e ) : void
selectFQN ( ) : void	select the element that matches the fqn in the clipboard
selectFQN ( string fqn ) : void
selectGUID ( ) : void	selects the element with the GUID in on the clipboard. If the clipboard doesn't contain a GUID we will ask the user to input one.
selectGUID ( string guidString ) : void	selects the element with the given guid
taggedValueMenuName ( string taggedValueName ) : string	adds the menu prefix and menu suffix to the tagged value name

Method Details

EAAddin() public method

public EAAddin ( ) : System
return	System

EA_FileClose() public method

public EA_FileClose ( EA Repository ) : void
Repository	EA
return	void

EA_FileOpen() public method

public EA_FileOpen ( EA Repository ) : void
Repository	EA
return	void

EA_GetMenuItems() public method

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.

public EA_GetMenuItems ( EA Repository, string MenuLocation, string MenuName ) : object
Repository	EA	An EA.Repository object representing the currently open Enterprise Architect model. /// Poll its members to retrieve model data and user interface status information.
MenuLocation	string	String representing the part of the user interface that brought up the menu. /// Can be TreeView, MainMenu or Diagram.
MenuName	string	The name of the parent menu for which sub-items are to be defined. In the case of the top-level menu it is an empty string.
return	object

EA_MenuClick() public method

Execute the actual functions

public EA_MenuClick ( global Repository, String Location, String MenuName, String ItemName ) : void
Repository	global	the repository
Location	String	menu location
MenuName	String	menu name
ItemName	String	option clicked
return	void

EA_OnContextItemChanged() public method

the EA hook we use to show the selected element in the Navigator window

public EA_OnContextItemChanged ( global Repository, string GUID, global ot ) : void
Repository	global
GUID	string
ot	global
return	void

EA_OnPostInitialized() public method

public EA_OnPostInitialized ( EA Repository ) : void
Repository	EA
return	void

EA_OnPostOpenDiagram() public method

public EA_OnPostOpenDiagram ( EA Repository, int DiagramID ) : void
Repository	EA
DiagramID	int
return	void

getElementsToNavigate() public method

returns the items to navigate based on the given element and chosen option.

public getElementsToNavigate ( string menuChoice, TSF.UmlToolingFramework.UML parentElement ) : List
menuChoice	string	the chosen option
parentElement	TSF.UmlToolingFramework.UML	the elememnt
return	List

quickSearch() public method

public quickSearch ( string searchText ) : void
searchText	string
return	void