Search
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

Initializes a new instance of the DiagramLink class between the specified nodes using the specified diagram link as a prototype.

 Protected Fields

  Name Description

disposed

For internal use. (Inherited from DiagramItem.)

 Public Properties

  Name Description

autoRoute

Gets or sets whether this link should be automatically routed to avoid crossing nodes.

baseBrush

Gets or sets an object that specifies how to fill link's baseShape.

baseShape

Gets or sets the arrowhead shape displayed at the link' start point.

baseShapeSize

Gets or sets the size of the arrowhead displayed at the link's start point.

Brush

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

controlPoints

Gets or sets the control points of this link.

destination

Gets or sets the destination node of this link.

destinationAnchor

Gets or sets the anchor point to which the link connects at its destination.

destinationIndex

Gets or sets the index of link's destination row when destination is a TableNode.

dynamic

Gets or sets whether link's end segments are automatically adjustedin order to keep pointing to the centers of the nodes 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.)

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 this link.

Font

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

headBrush

Gets or sets an object that specifies how to fill link's headShape.

headShape

Gets or sets the arrowhead shape displayed at the link' end point.

headShapeSize

Gets or sets the size of the arrowhead displayed at the link's end point.

headStroke

Gets or sets the brush used to stroke the outline of link's arrowheads.

headStrokeDashStyle

Gets or sets the dash pattern of arrowhead outlines.

headStrokeThickness

Gets or sets the thickness of arrowhead outlines.

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

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

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 this link.

originAnchor

Gets or sets the anchor point to which the link connects at its origin.

originIndex

Gets or sets the index of link's origin row when origin is a TableNode.

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

RuntimeIndex

For internal use. (Inherited from DiagramItem.)

segmentCount

Gets or sets the number of segments that form the link's geometry.

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 oriented relatively to each other.

startPoint

Gets or sets the first control point of this 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 by this link.

Text

Gets or sets the text displayed by this item. (Inherited from DiagramItem.)

textAlignment

Gets or sets the alignment of link's text.

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 placement and orientation of link's text.

ToolTip

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

TopLevel

True if this is a top-level item in the diagram, or false if it is inside a container. (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 this item. (Inherited from DiagramItem.)

 Protected Properties

  Name Description

MeasureUnit

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

 Public Methods

  Name Description

addLabel

Adds a new label to this link.

allowDrag

DiagramItem.allowDrag override.

clone

DiagramItem.clone override.

Clone

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

containsPoint

DiagramItem.containsPoint override.

ContainsPoint

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

Dispose

Overloaded.   (Inherited from DiagramItem.)

DoModify

For internal use. (Inherited from DiagramItem.)

Draw

Draws the item on the specified IGraphics surface. (Inherited from DiagramItem.)

DrawHandles

Renders the adjustment handles of this item. (Inherited from DiagramItem.)

DrawShadow

Draws the shadow of this item on the specified IGraphics surface. (Inherited from DiagramItem.)

endDrag

DiagramItem.endDrag override.

fromJson

DiagramItem.fromJson override.

GetBounds

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

GetEffectiveBrush

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

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

getLength

Gets the length of the links

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

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

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

HitTestManipulators

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

intersects

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

loadFromXml

DiagramItem.LoadFromXml override. Loads the link's content from an XML element.

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

Called after successful deserialization. (Inherited from DiagramItem.)

pointAlongLength

Returns a point lying on a polyline that is positioned at a relative position along the polyline's length.

putEndPointsAtNodeBorders

Places the link's end points on the outline of its origin and destination nodes.

Query

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

removeLabel

Removes the specified label from this link.

RestoreItemProperties

For internal use. (Inherited from DiagramItem.)

restoreLocationState

DiagramItem.restoreLocationState override.

restoreState

DiagramItem.restoreState override.

route

Routes this link, regardless of whether the link's autoRoute property is enabled.

SaveItemProperties

For internal use. (Inherited from DiagramItem.)

saveLocationState

DiagramItem.saveLocationState override.

saveState

DiagramItem.saveState override.

saveToXml

Saves the item's content into an XML element.

setDestination

Sets the destination node of this link.

startDrag

DiagramItem.startDrag override.

toJson

DiagramItem.toJson override.

updateCanvasElements

Updates the elements on the HTML Canvas.

updateDrag

DiagramItem.updateDrag override.

updateFromPoints

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

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

Invoked during interactive creation of items to test whether the operation can be completed in the current context. (Inherited from DiagramItem.)

AllowModify

Invoked during interactive modification of items to test whether the operation can be completed in the current context. (Inherited from DiagramItem.)

CancelModify

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

CompleteCreate

Invoked when the item creation has been completed. (Inherited from DiagramItem.)

CompleteModify

Invoked when the item modification has been completed. (Inherited from DiagramItem.)

CreateProperties

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

CreateState

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

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 item from the specified reader. (Inherited from DiagramItem.)

LoadFromJson

Loads the item from a JSON object. (Inherited from DiagramItem.)

LoadFromXml

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

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

OnStyleChanged

Invoked when the associated style or theme have changed. (Inherited from DiagramItem.)

OnTextChanged

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

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

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

RestoreState

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

SaveProperties

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

SaveState

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

SaveTo

Serializes the item to the specified writer. (Inherited from DiagramItem.)

SaveToJson

Saves the item as a JSON object. (Inherited from DiagramItem.)

SaveToXml

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

SetDiagramDirty

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

SetExpanded

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

SetReference

Called during deserialization, after all objects have been instantiated, in order to update the references between them. (Inherited from DiagramItem.)

ShouldRender

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

StartCreate

Invoked once when the user starts creating a new item interactively. (Inherited from DiagramItem.)

StartModify

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

UpdateCreate

Invoked during interactive creation of this item. (Inherited from DiagramItem.)

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

Invoked during interactive modification of this item. (Inherited from DiagramItem.)

 See Also