DiagramLinks

Return to Introduction  Previous page  Next page

public Class

A DiagramLink is an object that holds display information about a connector between two elements in a specific diagram. It includes, for example, the custom points and display appearance. Accessed from the Diagram DiagramLinks collection.

Associated table in .EAP file: t_diagramlinks

DiagramLinks Attributes

Attribute

Type

Notes

DiagramID

Long

Read/Write. The local ID for the associated diagram.

ConnectorID

Long

Read/Write. The ID of the associated connector.

Geometry

String

Read/Write. The geometry associated with the current connector in this diagram.

IsHidden

Boolean

Read/Write. Flag to indicate if this item is hidden or not.

Path

String

Read/Write. The path of the connector in this diagram.

Style

String

Read/Write. Additional style information; eg. color, thickness. 

InstanceID

Long

Read only attribute. Holds the link identifier for the current model.

ObjectType

ObjectType

Read only.  Distinguishes objects referenced through a Dispatch interface.

DiagramLinks Methods

Method

Type

Notes

GetLastError () 

String

Returns a string value describing the most recent error that occurred in relation to this object.

This function is rarely used since an exception is thrown when an error occurs.

Update () 

Boolean 

Update the current DiagramLink object after modification or appending a new item. If false is returned, check the GetLastError function for more information.