ArcObjects Library Reference  (Schematic)    

INgLink Interface

Provides access to members that control the graphic link.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Schematics Extension.

Description

A link is an edge in a network graph. A link can go through a number of “link points” (also called intermediate points or vertices) that modify its path. It is represented either by a direct single line segment or by several line segments passing through one or several link points. The path between two link points may be graphically broken. All types of patterns may be drawn up along a link path that may also have any given line style (dot, dash, and so forth) and width. A link can have a direction: Arrows placed on its start and end points show this. If a link path goes through one or several nodes, it can be modified so as to allow the nodes to be automatically bypassed. The common properties of a link are stored and defined by its related link type.

Members

Description
Method AddPatternModel Adds the pattern model 'patternModel' on the link.
Method AddPoint Adds the link point 'numPoint' (that is, adds the vertex 'numpoint') at the position 'point' on the link.
Read-only property CurrentPatternModels List of the pattern models currently associated with the link.
Read-only property Diagram Diagram that contains the link.
Read-only property ElementType Element type that implements the link.
Read/write property FromNode Origin node of the link.
Read-only property FromPoint Point position where the link connects its origin node, if a port is not specified for the connection.
Read/write property FromPort Sequence number of the origin node port onto which the link snaps if a port is used for the connection.
Method GetCurrentEffect Returns the current 'effValue' value for the effect 'effect' set for the link (see esriNgLinkEffect).
Method GetEffect Returns the effect 'effect' set for the link (see esriNgLinkEffect).
Method GetNumSegmentAtPoint Returns the sequence number of the link's segment located at the position 'point' in the view 'view'.
Read/write property InitialPoints List of the intermediate points that initially defined the link path.
Method IsEffectSet Indicates if the effect 'effect' related to the link is set (see esriNgLinkEffect).
Method MovePoint Moves the link point 'numPoint' at the relative or absolute (x,y) position.
Read-only property Name Name of the link.
Read-only property NodesOnLink List of the nodes-on-link related to the link.
Read-only property NumberOfPoints Number of intermediate points (vertices) along the link path.
Read-only property PatternModels List of the pattern models directly associated with the link.
Read-only property Points List of the intermediate points (vertices) that defines the link path (in the view 'view').
Method RemoveAllPoints Removes all of the link points (that is, all vertices) on the link.
Method RemoveEffect Removes the effect or restores the default effect 'effect' set for the link (see esriNgLinkEffect).
Method RemovePatternModel Removes the pattern model 'patternModel' assigned to the link.
Method RemovePoint Removes the 'numPoint' link point (that is, removes the vertex 'numpoint') on the link.
Method RestoreInitialPosition Restores the link to its initially defined position (that is, with or without its initially defined vertices).
Method SetEffect Modifies the effect 'effect' set for the link (see esriNgLinkEffect).
Read-only property SubLinks List of the sub-links related to the link.
Read/write property ToNode End node of the link.
Read-only property ToPoint Point position where the link connects its end node, if a port is not specified for the connection.
Read/write property ToPort Sequence number of the end node port onto which the link snaps if a port is used for the connection.

CoClasses that implement INgLink

CoClasses and Classes Description
NgLink Graphic link object.
NgSubLink Graphic sublink object.

See Also

INgElement Interface | ISchematicLink Interface | INgSubLink Interface

 


Feedback Send feedback on this page