EARules_GetPropertyString

EARules_GetPropertyString allows an Add-In registered to provide rules for a language to override the text for the property string of an element. In standard UML notation this is rendered between '{' and '}' near the name.

This event occurs during diagram drawing.

Syntax

Function EARules_GetPropertyString (Repository As EA.Repository, Language As String, Element as EA.Element, Order as Integer) As String

The EARules_GetPropertyString 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
Order	Integer Direction: OUT Description: Controls the order in which text provided by base rules is added to the return value. Assign a negative value to place the base property string ahead of the return value Assign a positive value to place the base property string after the return value Assign zero to prevent the base property string from being displayed

Return Value

A string defining the contents of the property string used in the default element notation.