EA_OnRunDiagramRule

Return to Introduction  Previous page  Next page

Syntax

Sub EA_OnRunDiagramRule(Repository As EA.Repository, RuleID As String, DiagramID As Long)

The EA_OnRunDiagramRule function syntax contains the following elements:

Parameter

Type

Direction

Description

Repository

EA.Repository

IN

An EA.Repository object representing the currently open Enterprise Architect model. Poll its members to retrieve model data and user interface status information.

RuleID

String

IN

The ID that was passed into the Project.DefineRule command.

DiagramID

Long

IN

The ID of the Diagram to potentially perform validation on. Use the Repository.GetDiagramByID method to retrieve the Diagram object.

Details

This event is triggered once for each rule defined in EA_OnInitializeUserRules to be performed on each Diagram in the selection being validated. If you don't want to perform the rule defined by RuleID on the given Diagram, then simply return without performing any action. On performing any validation, if a validation error is found, use the Repository.ProjectInterface.PublishResult method to notify Enterprise Architect.

See Also

EA_OnInitializeUserRules