MouseXPos (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Error
Various
Limits in browser code

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

MouseXPos (Function)

In french: SourisPosX

Used in a process linked to the mouse or stylus (click code, rollover code, code of left or right button down), returns the horizontal position (X) of the mouse cursor in relation to the specified window or control.

You can find out:

the position of the mouse (or stylus) when a left click is performed in an image (function used in the click code of image).
the position of the mouse (or stylus) when hovering a window (function used in the optional "Mouse rollover" process of window).

Used in a browser process (of a control or page), returns the horizontal position (X) of mouse cursor according to the specified marker.

Remarks:

The mouse position can also be returned by CursorPos. CursorPos should only be used to modify the mouse position.
This function should only be used in the processes of controls hovered by the mouse.
MouseXPos returns the last known position of finger on the device screen.

Versions 16 and later

This function is now available for Android applications.

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Android applications.

This function is now available for Windows Phone applications.

This function is now available for Android applications.

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// "WIN_Drawing" window hovered by the mouse
// Optional code of the window
Message("Position of the mouse: X: " + MouseXPos() + "Y: " + MouseYPos())

// Displays a different message according to the location clicked
IF MouseXPos() > 25 THEN
Info("To the right")
ELSE
Info("To the left")
END

// "Drawing" page hovered by the mouse
// Optional code of the page
// Mouse moved (onmousemove)
Message("Position of the mouse: X: " + MouseXPos(mpPage) + "Y: " + MouseYPos(mpPage))

Syntax

Retrieving the mouse position in a window Hide the details

<Result> = MouseXPos([<Marker>])

<Result>: Integer

Horizontal position (or X coordinate) of the mouse (or stylus) in pixels. By default, this position is given in relation to the top left corner of control on which the left mouse button was pressed.
-1 if an error occurred.

<Marker>: Optional Integer constant

Versions 17 and later
Marker used to calculate the position:
mpControl
(Default value) Mouse position in relation to the top left corner of window (or window if the event occurs on the window).
If this constant is selected, MouseXPos must be used in the click code of the control.
mpScreen Mouse position in the screen (in relation to the top left corner of screen).
mpWindow Mouse position in relation to the top left corner of window.
mpImage Mouse position in the image (in relation to the top left corner of image).
If this constant is selected, MouseXPos must be used in the click code of the Image control.
New in version 17
Marker used to calculate the position:
mpControl
(Default value) Mouse position in relation to the top left corner of window (or window if the event occurs on the window).
If this constant is selected, MouseXPos must be used in the click code of the control.
mpScreen Mouse position in the screen (in relation to the top left corner of screen).
mpWindow Mouse position in relation to the top left corner of window.
mpImage Mouse position in the image (in relation to the top left corner of image).
If this constant is selected, MouseXPos must be used in the click code of the Image control.
Marker used to calculate the position:
mpControl
(Default value) Mouse position in relation to the top left corner of window (or window if the event occurs on the window).
If this constant is selected, MouseXPos must be used in the click code of the control.
mpScreen Mouse position in the screen (in relation to the top left corner of screen).
mpWindow Mouse position in relation to the top left corner of window.
mpImage Mouse position in the image (in relation to the top left corner of image).
If this constant is selected, MouseXPos must be used in the click code of the Image control.

Retrieving the mouse position in a page Hide the details

<Result> = MouseXPos([<Marker>])

<Result>: Integer or real

Horizontal position (or X coordinate) of the mouse cursor in relation to the specified marker (in pixels),
0 if the information is not available (depending on the browser used and on the control).

<Marker>: Optional integer constant

Marker used to calculate the position:
mpControl
(Default value) Mouse position in relation to the top left corner of control (or page if the event occurs on the page).
If this constant is selected, MouseXPos must be used in the "OnClick" code of the control.
mpScreen Mouse position in the screen (in relation to the top left corner of screen).
mpPage Mouse position in relation to the top left corner of page (while taking the page "scrolling" into account).

Remarks

Error

The main error codes are as follows:

No window is opened.
No mouse click is performed.
MouseXPos is called in a code other than the click code of a control.
Click code run by Execute or ExecuteProcess.

Various

The vertical position of the mouse (or stylus) is returned by MouseYPos.
MouseXPos used in the selection code of row or table always returns 0.
This function should only be used in the processes of controls hovered by the mouse.

Limits in browser code

MouseXPos is not available:

in the browser procedures.
in the events directly or indirectly called from a browser procedure (via ExecuteProcess for example).
in the browser code of a button or link.

Related Examples:

Unit examples (WINDEV): The drawing functions

[ + ] Using the main drawing functions of WINDEV to:
- Initialize an Image control for drawing
- Draw simple shapes
- Write a text into a drawing
- Change the color in a drawing

Component : wd250obj.dll