PickNearestPort Method

Find the valid document port nearest to a given point.

Syntax

Visual Basic
C#

'Declaration
 
Public Overridable Function PickNearestPort( _
   ByVal dc As PointF _
) As IGoPort

public virtual IGoPort PickNearestPort( 
   PointF dc
)

Parameters

dc: a PointF in document coordinates

Remarks

A nearby port (as determined by the distance between dc and the result of PortPoint) must be within the GoView.PortGravity distance for it to qualify, and it must be in a GoLayer that is visible. This uses the IsValidLink predicate, passing it the OriginalStartPort along with each port to be considered. The results of IsValidLink are cached in ValidPortsCache, for the cases where determining valid links is computationally expensive. This cache is valid only for the duration of this linking tool as the current tool; it is cleared each time this tool is stopped.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

GoToolLinking Class
GoToolLinking Members