Mouse.GetPosition Method (IInputElement)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets the position of the mouse relative to a specified element.

Namespace:   System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)

Public Shared Function GetPosition (
	relativeTo As IInputElement
) As Point


Type: System.Windows.IInputElement

The coordinate space in which to calculate the position of the mouse.

Return Value

Type: System.Windows.Point

The position of the mouse relative to the parameter relativeTo.

The position of the mouse pointer is calculated relative to the specified element with the upper-left corner of element being the point of origin, 0,0.

During drag-and-drop operations, the position of the mouse cannot be reliably determined through GetPosition. This is because control of the mouse (possibly including capture) is held by the originating element of the drag until the drop is completed, with much of the behavior controlled by underlying Win32 calls. Try the following approaches instead:

The following example shows how to use GetPosition to determine the position of the mouse pointer. The position of the mouse pointer is stored in a Point structure. The X and Y values of the Point object are displayed in a TextBox.

' displayArea is a StackPanel and txtBoxMousePosition is
' a TextBox used to display the position of the mouse pointer.
Dim position As Point = Mouse.GetPosition(displayArea)
txtBoxMousePosition.Text = "X: " & position.X & vbLf & "Y: " & position.Y

.NET Framework
Available since 3.0
Return to top