Topic
Prev Next

DiagramLinks Class

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

Associated table in .EAP file

t_diagramlinks

DiagramLinks Attributes

Attribute

Remarks

See also

ConnectorID

Long

Notes: Read/Write

The ID of the associated connector.

DiagramID

Long

Notes: Read/Write

The local ID for the associated diagram.

Geometry

String

Notes: Read/Write

The geometry associated with the current connector in this diagram.

HiddenLabels

Boolean

Notes: Indicates if this connector's labels are hidden on the diagram.

InstanceID

Long

Notes: Read only

The connector identifier for the current model.

IsHidden

Boolean

Notes: Read/Write

Indicates if this item is hidden or not.

LineColor

Long

Notes: Sets the line color of the connector.

Set to -1 to reset to the default color in the model.

LineStyle

Long

Notes: Sets the line style of the connector.

1 = Direct

2 = Auto Routing

3 = Custom Line

4 = Tree Vertical

5 = Tree Horizontal

6 = Lateral Vertical

7 = Lateral Horizontal

8 = Orthogonal Square

9 = Orthogonal Rounded

LineWidth

Long

Notes: Sets the line width of the connector.

ObjectType

ObjectType

Notes: Read only

Distinguishes objects referenced through a Dispatch interface.

ObjectType

Path

String

Notes: Read/Write

The path of the connector in this diagram.

SourceInstanceUID

String

Notes: Read only

Returns the Unique Identifier of the source object.

SuppressSegment

Boolean

Notes: Indicates whether the connector segments are suppressed.

Style

String

Notes: Read/Write

Additional style information; for example, color or thickness.

TargetInstanceUID

String

Notes: Read only

Returns the Unique Identifier of the target object.

DiagramLinks Methods

Method

Remarks

See also

GetLastError()

String

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

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

Update()

Boolean

Notes: Update the current DiagramLink object after modification or appending a new item.

If False is returned, check the 'GetLastError()' function for more information.

Learn more