Diagram.GetLinkAt Method (PointF, Single, Boolean)

Finds and returns the top-most link that lies at the specified location, optionally excluding locked links from the search.

Namespace: MindFusion.Diagramming
Package: MindFusion.Diagramming

 Syntax

C#

public DiagramLink GetLinkAt (
    PointF pt,
    float maxDist,
    bool exclLocked
)

Visual Basic

Public Function GetLinkAt( _
    pt As PointF, _
    maxDist As Single, _
    exclLocked As Boolean _
) As DiagramLink

 Parameters

pt

A PointF 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.

 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. The specified point might not be laying exactly on the link, but within a certain threshold distance from it. This threshold is specified through the second parameter. Locked and invisible links can be skipped from the search by setting the third parameter to true.