Prev Next

EARules_ShowParentFrame

EARules_ShowParentFrame allows an Add-In registered to provide rules for a language to determine if the owner of a diagram should always be displayed on the diagram as a diagram frame.

This event occurs during diagram load.

Syntax

Function EARules_ShowParentFrame (Repository As EA.Repository, Language As String, Diagram as EA.Diagram) As Integer

The EARules_ShowParentFrame 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

Diagram

EA.Diagram

Direction: IN

Description: Specifies the diagram currently being loaded.

Diagram Class

Return Value

  • Return a positive value to specify that the parent element should be shown as a frame on this diagram
  • Return zero to specify the name should not be displayed on the diagram
  • Return a negative value to use the behavior from the base rules