Enterprise Architect enables Add-Ins to integrate with the Model Search (as described in the Enterprise Architect User Guide). Searches can be defined that execute a method within your Add-In and display your results in an integrated way.
The method that runs the search must be structured in the following way:
variant <method name> (Rep as Repository, SearchText as String, XMLResults as String)
Parameter |
Description |
Rep |
The currently open repository. |
SearchText |
An optional field that the you can fill in through the Model Search. |
XMLResults |
At completion of the method, this should contain the results for the search. The results should be an XML String that conforms to the Search Data Format. |
Return:
The method must return a value for the results to be displayed.
Advanced Usage
In addition to the displayed results, two additional hidden fields can be passed into the XML that provide special functionality.
CLASSTYPE
Returning a field of CLASSTYPE, containing the Object_Type value from the t_object table, displays the appropriate icon in the column you place the field.
CLASSGUID
Returning a field of CLASSGUID, containing an ea_guid value, enables the Model Search to track the object in the Project Browser window and open the Properties window for the element by double-clicking in the Model Search.