Given a mouse position (in root-space coordinates), determines the point related to the specified element to snap to the grid. The returned point will be the point closest to the mouse position, based on the snap sub-options configured for this instance of GwxGridOptions.

Namespace: Ico.Gwx
Assembly: GwxConfigCore (in GwxConfigCore.dll) Version: 10.97.212.0 (10.97.212.00)

Syntax

C#
public Point FindPointToSnap(
	Point mouseDownRootSpace,
	GwxElement gwxElement,
	Nullable<Rect> overrideBounds,
	out string pointDescription
)
Visual Basic
Public Function FindPointToSnap ( _
	mouseDownRootSpace As Point, _
	gwxElement As GwxElement, _
	overrideBounds As Nullable(Of Rect), _
	<OutAttribute> ByRef pointDescription As String _
) As Point
JScript
public function FindPointToSnap(
	mouseDownRootSpace : Point, 
	gwxElement : GwxElement, 
	overrideBounds : Nullable<Rect>, 
	pointDescription : String
) : Point

Parameters

mouseDownRootSpace
Type: System.Windows..::..Point
A mouse position (in root-space coordinates)
gwxElement
Type: Ico.Gwx..::..GwxElement
An element that provides context for the point to find (ex. bounding box of the element, or shape vertices of the element). Can be null.
overrideBounds
Type: System..::..Nullable<(Of <(<'Rect>)>)>
Optionally provides bounds to use for finding the point (overrides the bounding box of gwxElement). Can be null.
pointDescription
Type: System..::..String%
Outputs a description of the kind of point that was found.

Return Value

The point to use for snapping.

See Also