DiagramLite 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.  

 Public Fields

  Name Description

AllowMoveEndProperty

Identifies the AllowMoveEnd dependency property.

AllowMoveStartProperty

Identifies the AllowMoveStart dependency property.

BaseBrushProperty

Identifies the BaseBrush dependency property.

HeadBrushProperty

Identifies the HeadBrush dependency property.

HeadStrokeProperty

Identifies the HeadStroke dependency property.

HeadStrokeThicknessProperty

Identifies the HeadStrokeThickness dependency property.

IntermediateBrushProperty

Identifies the IntermediateBrush dependency property.

TextProperty

Identifies the Text dependency property.

 Inherited Public Fields

  Name Description

AutoCaptureMouseProperty

Identifies the AutoCaptureMouse dependency property. (Inherited from DiagramItem.)

BrushProperty

Identifies the Brush dependency property. (Inherited from DiagramItem.)

HyperLinkProperty

Identifies the HyperLink dependency property. (Inherited from DiagramItem.)

IsMouseDownProperty

Identifies the IsMouseDown dependency property. (Inherited from DiagramItem.)

IsMouseOverProperty

Identifies the IsMouseOver dependency property. (Inherited from DiagramItem.)

StrokeDashArrayProperty

Identifies the StrokeDashArray dependency property. (Inherited from DiagramItem.)

StrokeDashCapProperty

Identifies the StrokeDashCap dependency property. (Inherited from DiagramItem.)

StrokeDashOffsetProperty

Identifies the StrokeDashOffset dependency property. (Inherited from DiagramItem.)

StrokeEndLineCapProperty

Identifies the StrokeEndLineCap dependency property. (Inherited from DiagramItem.)

StrokeLineJoinProperty

Identifies the StrokeLineJoin dependency property. (Inherited from DiagramItem.)

StrokeMiterLimitProperty

Identifies the StrokeMiterLimit dependency property. (Inherited from DiagramItem.)

StrokeProperty

Identifies the Stroke dependency property. (Inherited from DiagramItem.)

StrokeStartLineCapProperty

Identifies the StrokeStartLineCap dependency property. (Inherited from DiagramItem.)

StrokeThicknessProperty

Identifies the StrokeThickness dependency property. (Inherited from DiagramItem.)

TextBrushProperty

Identifies the TextBrush dependency property. (Inherited from DiagramItem.)

 Inherited Protected Fields

  Name Description

handles

A list of the Rectangle objects that represent the item's adjustment handles. (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. This is a dependency property

AllowMoveStart

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

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.

BaseBrush

Gets or sets the brush used to paint the link's BaseShape.

BaseShape

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

BaseShapeSize

Gets or sets the size of the BaseShape shape.

CascadeOrientation

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

ControlPoints

Gets or sets a collection of the control points of 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.

DestinationIndex

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

DestinationRow

Gets or sets the row to which this link should be connected when the destination node is a table.

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.

EndPoint

Gets or sets the mouse position where the user ended drawing ot modifying a link.

HeadBrush

Gets or sets the brush used to paint the link's arrowhead shape.

HeadShape

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

HeadShapeSize

Gets or sets the size of the arrowhead shape.

HeadStroke

Gets or sets the Brush that specifies how the arrowhead stroke outline is painted. This is a dependency property.

HeadStrokeThickness

Gets or sets the width of the arrowhead stroke outline. This is a dependency property.

IntermediateBrush

Gets or sets the brush used to paint the link's IntermediateShape.

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.

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.

OriginIndex

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

OriginRow

Gets or sets the row to which this link should be connected when the origin node is a table.

SegmentCount

Gets or sets the number of segments of this link.

Shape

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

StartPoint

Gets or sets the mouse position where the user starts drawing or modifying the link.

Text

Gets or sets the text displayed over a link. This is a dependency property.

TextBlock

The control which displays the link text.

 Protected Properties

  Name Description

TargetNode

A node that will become the link's Origin or Destination if the current link drawing or modification operation completes at the current mouse pointer location.

 Inherited Public Properties

  Name Description

AutoCaptureMouse

Gets or sets whether the item should capture the mouse input when the left button is pressed over it. This is a dependency property. (Inherited from DiagramItem.)

Brush

Gets or sets the Brush that specifies how to paint the interior of the item. This is a dependency property. (Inherited from DiagramItem.)

Diagram

Gets the parent diagram. (Inherited from DiagramItem.)

HandlesStyle

Gets or sets a value indicating how the node adjustment handles behave and what do they look like. (Inherited from DiagramItem.)

HyperLink

Gets or sets the hyperlink associated with this diagram item. This is a dependency property. (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.)

IsMouseDown

Gets a value indicating whether the mouse button is pressed over this item. This is a dependency property. (Inherited from DiagramItem.)

IsMouseOver

Gets a value indicating whether the mouse pointer is located over this item. This is a dependency property. (Inherited from DiagramItem.)

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 properties specific to each layout algorithm. (Inherited from DiagramItem.)

Locked

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

RuntimeIndex

For internal use. (Inherited from DiagramItem.)

Selected

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

Stroke

Gets or sets the Brush that specifies how the item outline is painted. (Inherited from DiagramItem.)

StrokeDashArray

Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to outline nodes. This is a dependency property. (Inherited from DiagramItem.)

StrokeDashCap

Gets or sets a PenLineCap enumeration value that specifies how the ends of a dash are drawn. (Inherited from DiagramItem.)

StrokeDashOffset

Gets or sets a double value that specifies the distance within the dash pattern where a dash begins. This is a dependency property. (Inherited from DiagramItem.)

StrokeEndLineCap

Gets or sets a PenLineCap enumeration value that specifies what shape to draw at the end of a Stroke. (Inherited from DiagramItem.)

StrokeLineJoin

Gets or sets a PenLineJoin enumeration value that specifies the type of join that is used at the vertices of the item's outline. (Inherited from DiagramItem.)

StrokeMiterLimit

Gets or sets a limit on the ratio of the miter length to half the StrokeThickness of an item outline element. This is a dependency property. (Inherited from DiagramItem.)

StrokeStartLineCap

Gets or sets a PenLineCap enumeration value that specifies what shape to draw at the start of a Stroke. (Inherited from DiagramItem.)

StrokeThickness

Gets or sets the width of the DiagramItem stroke outline. (Inherited from DiagramItem.)

TextBrush

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

ToolTip

Gets or sets the contents of the tooltip displayed when the mouse pointer rests over the diagram element. (Inherited from DiagramItem.)

Visible

Gets or sets a value indicating whether this item is visible. (Inherited from DiagramItem.)

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 the object. (Inherited from DiagramItem.)

 Inherited Protected Properties

  Name Description

Size

Gets the size of this item. (Inherited from DiagramItem.)

 Public Methods

  Name Description

AddLabel

Overloaded.  

ContainsPoint

Determines whether this link contains the specified point.

GetBounds

Gets the bounding rectangle of this link.

GetNearestSegment

Gets the index of the links segment closest to the specified point.

GetRotatedBounds

DiagramItem.GetRotatedBounds override.

HitTestHandle

DiagramItem.HitTestHandle override.

Intersects

Checks whether the link contour intersects with the outline of the specified node.

LabelFromPoint

Returns the label whose layout rectangle contains the specified point.

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.

RestoreLocationState

DiagramItem.RestoreLocationState override.

Route

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

SaveLocationState

DiagramItem.SaveLocationState override.

UpdateFromPoints

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

 Protected Methods

  Name Description

AddHandlesToCanvas

Overloaded.  

AllowDrag

Invoked to validate the drag operation.

CreateState

DiagramItem.CreateState override.

EndDrag

DiagramItem.EndDrag override.

LoadFromXml

Loads the link content from an XML element.

OnLoad

DiagramItem.OnLoad override.

RestoreState

DiagramItem.RestoreState override.

SaveState

DiagramItem.SaveState override.

SaveToXml

Saves the link content into an XML element.

ScaleElements

Scales the link's elements by specified amount.

StartDrag

DiagramItem.StartDrag override.

UpdateDrag

DiagramItem.UpdateDrag override.

UpdateDynamicLink

Updates the control points of a dynamic link while one of the nodes it connects is being moved or resized.

UpdateTextLayout

Positions the TextBlock control displaying the link's text. Override to implement custom positioning if desired.

UpdateVisuals

DiagramItem.UpdateVisuals override.

 Inherited Public Methods

  Name Description

Clone

Creates a copy of this item. (Inherited from DiagramItem.)

ContainsPoint

Determines whether this item contains the specified point. (Inherited from DiagramItem.)

GetBounds

Gets the bounding rectangle of this item. (Inherited from DiagramItem.)

GetOutlinePoly

Gets a polygon approximating the outline of this object. (Inherited from DiagramItem.)

GetRepaintRect

Gets the repaint region for this item, taking into account factors such as pen, selection handles and shadow. (Inherited from DiagramItem.)

GetRotatedBounds

Gets the bounding rectangle of this item when it is rotated. (Inherited from DiagramItem.)

HitTestHandle

Determines whether a selection handle of this item is located at the specified point. (Inherited from DiagramItem.)

NotInteractive

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

OnApplyTemplate

Control.OnApplyTemplate override. (Inherited from DiagramItem.)

Query

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

RestoreLocationState

Restores the state of this diagram item. (Inherited from DiagramItem.)

SaveLocationState

Saves the state of this diagram item. (Inherited from DiagramItem.)

TransformDiagramToItem

Transforms a point in diagram coordinates to item coordinates. (Inherited from DiagramItem.)

TransformItemToDiagram

Gets the diagram coordinates of a point specified in the local coordinate system of this item. (Inherited from DiagramItem.)

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.)

 Inherited Protected Methods

  Name Description

AddHandlesToCanvas

Overloaded.   (Inherited from DiagramItem.)

AllowDrag

Invoked to validate the drag operation. (Inherited from DiagramItem.)

CancelDrag

Invoked when the interactive modification of this object has been canceled. (Inherited from DiagramItem.)

CreateState

Creates an item state corresponding to the type of this diagram item. (Inherited from DiagramItem.)

EndDrag

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

LoadFromXml

Loads the item content from an XML element. (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.)

OnLoad

Called after successful deserialization. (Inherited from DiagramItem.)

OnLostMouseCapture

Control.OnLostMouseCapture override. (Inherited from DiagramItem.)

OnMeasureUnitChanged

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

OnMouseEnter

Control.OnMouseEnter override. (Inherited from DiagramItem.)

OnMouseLeave

Control.OnMouseLeave override. (Inherited from DiagramItem.)

OnMouseLeftButtonDown

Control.OnMouseLeftButtonDown override. (Inherited from DiagramItem.)

OnMouseLeftButtonUp

Control.OnMouseLeftButtonUp override. (Inherited from DiagramItem.)

OnRemove

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

RemoveHandlesFromCanvas

Invoked when the item's selection handles should be removed. (Inherited from DiagramItem.)

RestoreState

Restores the state of this diagram item. (Inherited from DiagramItem.)

SaveState

Saves the state of this diagram item. (Inherited from DiagramItem.)

SaveToXml

Saves the item content into an XML element. (Inherited from DiagramItem.)

ScaleElements

Scales the item's elements by specified amount. (Inherited from DiagramItem.)

StartDrag

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

UpdateDrag

Invoked while the user drags this item. (Inherited from DiagramItem.)

UpdateHandleColors

Sets the handle colors according to the current selection state of the item and the enabled bits in the EnabledHandles property. (Inherited from DiagramItem.)

UpdateHandlePositions

Invoked when the item's selection handles should change their position. (Inherited from DiagramItem.)

UpdateStates

Sets the current VisualStates of this item. (Inherited from DiagramItem.)

UpdateVisuals

Invoked when an item should update its visual elements. (Inherited from DiagramItem.)

 See Also

DiagramLink Class
MindFusion.Diagramming Namespace