| Pré. | Proc. |
EARules_GetCompartmentName
EARules_GetCompartmentName allows an Add-In registered to provide rules for a language to override the label displayed at the top of a compartment.
This event occurs during diagram drawing.
Syntax
Function EARules_GetCompartmentName (Repository As EA.Repository, Language As String, Element as EA.Element, Compartment as String, Base as Integer) As String
The EARules_GetCompartmentName function syntax contains these parameters.
Parameter |
Description |
See also |
|---|---|---|
|
Repository |
EA.Repository Direction: IN Description: An EA.Repository object representing the currently-open Enterprise Architect model. Poll its members to retrieve model data and user interface status information. |
Repository Class |
|
Language |
String Direction: IN Description: Specifies the language for the rule that Enterprise Architect is requesting. This will match one of the values returned from EARules_Initialize. |
EARules_Initialize |
|
Element |
EA.Element Direction: IN Description: Specifies the element currently being drawn. |
Element Class |
|
Compartment |
String Direction: IN Description: Specifies the compartment being rendered. |
|
|
Base |
Integer Direction: OUT Description: Controls whether the base rules will be called if you return an empty value. A non-zero value and return of an empty string means that the parent rules will determine the display of the compartment name. |
Return Value
A string defining the name to be rendered for the specified compartment.