Diagram.GetLinkAt Method (PointF, Single, 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
Package: MindFusion.Diagramming

 Syntax

C#

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

Visual Basic

Public Function GetLinkAt( _
    pt As PointF, _
    maxDist As Single, _
    exclLocked As Boolean, _
    ByRef segmNum As Integer _
) 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.

segmNum

Returns the index of the link segment that lies at the specified point.

 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. The link's segment closest to the point is returned through the fourth parameter.