NetDiagram Programmer's Guide
DiagramLink Members
Constructors Fields Properties Methods
 


Represents a link between two diagram nodes.

The following tables list the members exposed by the DiagramLink type.

 Public Constructors

  Name Description

DiagramLink

Overloaded. Initializes a new instance of the DiagramLink class.

 Protected Fields

  Name Description

disposed

For internal use. (Inherited from DiagramItem.)

 Public Properties

  Name Description

AllowMoveEnd

Gets or sets a value indicating whether the user is allowed to move the end point of a link.

AllowMoveStart

Gets or sets a value indicating whether the user is allowed to move the first control point of a link.

AutoRoute

Gets or sets a value indicating whether a link should avoid nodes by going the shortest path from its origin to its destination without crossing any other nodes.

AutoSnapToNode

Specifies whether a link end point should automatically snap to the nearest diagram node while the user moves the point's adjustment handle.

BaseBrush

Gets or sets a brush used to fill the arrowhead drawn at the link base.

BaseShape

Gets or sets what shape to display at the beginning of a link.

BaseShapeSize

Gets or sets the size of the BaseShape shape.

Bounds

Gets the size of the rectangle that bounds this link.

Brush

Gets or sets the brush used to fill the interior of this item. (Inherited from DiagramItem.)

CascadeOrientation

Gets or sets the orientation of the first segment of a cascading link.

ControlPoints

Gets a collection of the control points of this link.

CrossingRadius

Gets or sets the radius length of decorations displayed at intersection points of this link.

CustomDraw

Gets or sets the type of custom drawing performed on this link.

Destination

Gets or sets the destination node of this link.

DestinationAnchor

Gets or sets the index of the destination anchor point within the AnchorPattern that contains it.

DestinationConnection

Gets or sets the ConnectionPoint object representing the link connection to its destination node. This allows connecting the link to a constituent part of a node, such as a TableNode row or a TreeViewItem.

DestinationIndex

Gets or sets the index of link's destination anchor point or table row.

DrawCrossings

Gets or sets a value indicating whether the points where this link crosses other links should be drawn as arcs or dashes.

Dynamic

Gets or sets a value indicating whether a link automatically adjusts its end points positions in order to keep pointing to the centers of nodes that it connects.

EffectiveBrush

Gets the effective brush of the item. (Inherited from DiagramItem.)

EffectiveFont

Gets the currently effective font of the item. (Inherited from DiagramItem.)

EffectiveHeadPen

Gets the effective head pen of the link.

EffectivePen

Gets the effective pen of the item. (Inherited from DiagramItem.)

EffectiveShadowBrush

Gets the effective shadow brush of the item. (Inherited from DiagramItem.)

EffectiveTextBrush

Gets the effective text brush of the item. (Inherited from DiagramItem.)

EndPoint

Gets or sets the last control point of a link.

Font

DiagramItem.Font override.

HandlesStyle

Gets or sets the appearance of the link's selection handles.

HeadBrush

Gets or sets a brush used to fill the arrowhead drawn at the link's destination.

HeadPen

Gets or sets the pen to use when painting arrowheads lines.

HeadShape

Gets or sets the shape of this link's arrowhead.

HeadShapeSize

Gets or sets the size of the arrowhead shape.

HyperLink

Gets or sets the hyperlink associated with this diagram item. (Inherited from DiagramItem.)

Id

Gets or sets user-defined identifier associated with this item. (Inherited from DiagramItem.)

IgnoreLayout

Gets or sets a value indicating whether the position of this item should not be changed by automatic layout methods. (Inherited from DiagramItem.)

IntermediateBrush

Gets or sets a brush used to fill the arrowheads drawn at the middle of link segments.

IntermediateShape

Gets or sets the shape displayed at the middle of each segment of the link.

IntermediateShapeSize

Gets or sets the size of the IntermediateShape shape.

IsConnected

Gets a value indicating whether the link is connected to nodes at both its ends.

Labels

Returns the list of all labels displayed by this link.

LayerIndex

Gets or sets the zero-based index of the layer this item is associated with, or -1, if the item is not associated with a layer. (Inherited from DiagramItem.)

LayoutTraits

Contains layout properties of the node, used by some layout algorithms and by DiagramView3D. (Inherited from DiagramItem.)

Length

Gets the length of the link.

Locked

Gets or sets a value indicating whether users are allowed to edit the diagram item. (Inherited from DiagramItem.)

Origin

Gets or sets the origin node of the link.

OriginAnchor

Gets or sets the index of the origin anchor point within the AnchorPattern that contains it.

OriginConnection

Gets or sets the ConnectionPoint object representing the link connection to its origin node. This allows connecting the link to a constituent part of a node, such as a TableNode row or a TreeViewItem.

OriginIndex

Gets or sets the index of link's origin anchor point or table row.

Parent

Gets the diagram that contains this item. (Inherited from DiagramItem.)

Pen

Gets or sets the pen used to paint the frame of the item. (Inherited from DiagramItem.)

Printable

Gets or sets a value indicating whether to print the item. (Inherited from DiagramItem.)

RetainForm

Gets or sets a value indicating whether a link should maintain its form if the nodes connected with that link are moved around.

RuntimeIndex

For internal use. (Inherited from DiagramItem.)

SegmentCount

Gets or sets the number of segments of this link.

Selected

Gets or sets a value indicating whether a diagram item is selected. (Inherited from DiagramItem.)

ShadowBrush

Gets or sets the brush used to paint the item's shadow. (Inherited from DiagramItem.)

ShadowOffsetX

Gets or sets the horizontal offset of the shadow of this item. (Inherited from DiagramItem.)

ShadowOffsetY

Gets or sets the vertical offset of the shadow of this item. (Inherited from DiagramItem.)

Shape

Gets or sets the type of link segments and how they are positioned relatively to each other.

StartPoint

Gets or sets the first control point of a link.

Style

Gets or sets the style associated with the item. (Inherited from DiagramItem.)

SubordinateGroup

Gets a reference to the group of items that are attached to this one. (Inherited from DiagramItem.)

Tag

Gets or sets user-defined data associated with this item. (Inherited from DiagramItem.)

Text

Gets or sets the text displayed over a link.

TextAlignment

Gets or sets the link's text placement and orientation.

TextBrush

Gets or sets the brush used to paint texts inside the item. (Inherited from DiagramItem.)

TextFormat

Gets or sets the alignment of text displayed inside this item. (Inherited from DiagramItem.)

TextPadding

Gets or sets the spacing between the item boundaries and its text. (Inherited from DiagramItem.)

TextStyle

Gets or sets the link's text placement and orientation.

ToolTip

Gets or sets a short text message displayed when the mouse pointer rests over the diagram element. (Inherited from DiagramItem.)

TopLevel

DiagramItem.TopLevel override.

Visible

DiagramItem.Visible override.

Weight

Gets or sets a weight value used in layout and path-finding algorithms. (Inherited from DiagramItem.)

ZIndex

Gets or sets the z-order position of this item. (Inherited from DiagramItem.)

 Protected Properties

  Name Description

MeasureUnit

Returns the diagram measure unit. (Inherited from DiagramItem.)

 Public Methods

  Name Description

AddLabel

Overloaded. Adds a label to this link.

Clone

Creates a copy of this link.

ContainsPoint

Overloaded.  

Dispose

Overloaded.   (Inherited from DiagramItem.)

DoModify

For internal use. (Inherited from DiagramItem.)

Draw

Draws the link on the specified IGraphics surface.

DrawArrowhead

Draws an arrowhead shape.

DrawHandles

DiagramItem.DrawHandles override. Renders the adjustment handles of this item.

DrawShadow

Draws the shadow of this link on the specified IGraphics surface.

GetBounds

Overloaded.  

GetEffectiveBrush

Creates a System.Drawing.Brush object representing the currently effective brush of the item. (Inherited from DiagramItem.)

GetEffectiveHeadPen

Creates a System.Drawing.Pen object representing the currently effective head pen of the link.

GetEffectivePen

Creates a System.Drawing.Pen object representing the currently effective pen of the item. (Inherited from DiagramItem.)

GetEffectiveShadowBrush

Creates a System.Drawing.Brush object representing the currently effective shadow brush of the item. (Inherited from DiagramItem.)

GetEffectiveTextBrush

Creates a System.Drawing.Brush object representing the currently effective text brush of the item. (Inherited from DiagramItem.)

GetLongestHSegment

Returns the index of the longest horizontal segment of this link.

GetOutlinePoly

DiagramItem.GetOutlinePoly override.

GetRepaintRect

DiagramItem.GetRepaintRect override.

GetRotatedBounds

DiagramItem.GetRotatedBounds override.

GetToolTip

Gets the tooltip that should be displayed for this item at the specified point. (Inherited from DiagramItem.)

HitTest

Returns the diagram item that contains the specified point. (Inherited from DiagramItem.)

HitTestHandle

DiagramItem.HitTestHandle override. Determines whether a selection handle of this item is located at the specified point.

HitTestManipulators

Finds the Manipulator object located at the specified point. (Inherited from DiagramItem.)

Intersects

Overloaded.  

LabelFromPoint

Returns the label whose layout rectangle contains the specified point.

NotInteractive

Gets whether the user is prevented from manipulating this item. (Inherited from DiagramItem.)

NowModifying

Gets a flag indicating whether this object is being currently modified interactively by the user. (Inherited from DiagramItem.)

OnLoad

DiagramItem.OnLoad override.

Query

Returns the items that can be reached from this item by following the path specified in the given query expression. (Inherited from DiagramItem.)

ReassignAnchorPoints

Attaches the link end points to the anchor points defined for the link's origin and destination nodes.

RemoveLabel

Removes the specified label from this link.

RestoreItemProperties

For internal use. (Inherited from DiagramItem.)

Route

Routes this link, regardless of whether the link's AutoRoute flag is enabled.

SaveItemProperties

For internal use. (Inherited from DiagramItem.)

SetOrgAndDest

Sets the origin and destination links of this link.

UpdateAnimation

Invoked by running animations to update an item according to current animation progress.

UpdateFromPoints

Overloaded. Updates the link's internal state after the link's control points have been changed.

UpdateIntersections

Aligns the link ends to the contour of the nodes it connects.

ZBottom

Moves the item to the bottom of the z-order. (Inherited from DiagramItem.)

ZLevelDown

Moves the item one level down in the z-order. (Inherited from DiagramItem.)

ZLevelUp

Moves the item one level up in the z-order. (Inherited from DiagramItem.)

ZTop

Moves the item to the top of the z-order. (Inherited from DiagramItem.)

 Protected Methods

  Name Description

AddManipulator

Adds the specified manipulator to this object. (Inherited from DiagramItem.)

AllowCreate

DiagramItem.AllowCreate override.

AllowModify

DiagramItem.AllowModify override.

CancelModify

DiagramItem.CancelModify override.

CompleteCreate

DiagramItem.CompleteCreate override.

CompleteModify

DiagramItem.CompleteModify override.

CreateProperties

DiagramItem.CreateProperties override.

CreateState

DiagramItem.CreateState override.

DrawManipulators

Overloaded. Draws the associated manipulators on a specified graphics. (Inherited from DiagramItem.)

Finalize

DiagramItem finalizer. (Inherited from DiagramItem.)

FreeResources

Called when the item is completely disassociated from a Diagram, that is, when it is no longer referenced from an item collection or the undo/redo history. (Inherited from DiagramItem.)

GetValue

Gets the effective value of the style property with the specified name. (Inherited from DiagramItem.)

LoadFrom

Deserializes the object from the specified reader.

LoadFromJson

Loads the link from a JSON object.

LoadFromXml

Loads the link content from an XML element.

LoadObsolete

For internal use. (Inherited from DiagramItem.)

OnAdd

Called when the item is added to a Diagram, either by the user, programmatically or via undo / redo. (Inherited from DiagramItem.)

OnChildModified

Called when a group child node has been modified. (Inherited from DiagramItem.)

OnClick

Invoked when the user clicks this item. (Inherited from DiagramItem.)

OnDoubleClick

Invoked when the user double-clicks this item. (Inherited from DiagramItem.)

OnMeasureUnitChanged

Called when the Diagram's MeasureUnit changes.

OnModify

Invoked when the user moves any control point of the link.

OnRemove

Called when an item is removed from a Diagram, either by the user, programmatically or via undo / redo. (Inherited from DiagramItem.)

OnStyleChanged

Diagramitem.OnStyleChanged override.

OnTextChanged

DiagramItem.OnTextChanged override.

OnTextFormatChanged

Called when the value of the TextFormat property changes. (Inherited from DiagramItem.)

OnZoomChanged

Called when the diagram's ZoomFactor changes. (Inherited from DiagramItem.)

RemoveManipulator

Removes the specified manipulator from the object. (Inherited from DiagramItem.)

Repaint

Overloaded.   (Inherited from DiagramItem.)

RestoreProperties

DiagramItem.RestoreProperties override.

RestoreState

DiagramItem.RestoreState override.

SaveProperties

DiagramItem.SaveProperties override.

SaveState

DiagramItem.SaveState override.

SaveTo

Serializes the object to the specified writer.

SaveToJson

Saves the link as a JSON object.

SaveToXml

Saves the link content into an XML element.

SetDiagramDirty

Marks the diagram as changed. (Inherited from DiagramItem.)

SetExpanded

Sets whether the item is in expanded or collapsed state. (Inherited from DiagramItem.)

SetReference

Updates the reference to the specified object.

ShouldRender

Determines whether the item should be rendered in the current context. (Inherited from DiagramItem.)

StartCreate

DiagramItem.StartCreate override.

StartModify

DiagramItem.StartModify override. Invoked when the user starts modifying this item interactively.

UpdateCreate

DiagramItem.UpdateCreate override.

UpdateGroup

Called to update the positions of subordinate nodes attached to this item when the attachment style is set to ControlledByMaster. (Inherited from DiagramItem.)

UpdateModify

DiagramItem.UpdateModify override.

 See Also

DiagramLink Class
MindFusion.Diagramming Namespace