Diagram.GetLinkAt Method (Point, Double, Boolean, Int32@)

Finds and returns the top-most link that lies at the specified location, optionally excluding locked links from the search. The zero-based index of the exact link segment at the specified position is also returned.

Namespace: MindFusion.Diagramming
Assembly: MindFusion.Diagramming.Silverlight

 Syntax

C#

public DiagramLink GetLinkAt (
    Point pt,
    double maxDist,
    bool exclLocked,
    ref int segmNum
)

Visual Basic

Public Function GetLinkAt( _
    pt As Point, _
    maxDist As Double, _
    exclLocked As Boolean, _
    ByRef segmNum As Integer _
) As DiagramLink

 Parameters

pt

A Point instance identifying a diagram location.

maxDist

The maximal distance between the point and a link, within which to consider the point as lying on the link.

exclLocked

Specifies that locked links should be ignored by the search.

segmNum

The zero-based index of the link's segment at which the point is lying is returned here.

 Return Value

The DiagramLink found or a null reference (Nothing in Visual Basic) if no item has been found.

 Remarks

Call the method to get the link at a certain place in the document. The method searches starting from the top of z-order and returns the first link found.