MouseXPos (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Error
Various
Limits in browser code

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

MouseXPos (Function)

In french: SourisPosX

Used in an linked event with the mouse or the stylus (click code, hover code, left or right button pressed code, ...) returns the horizontal (X) position of the mouse cursor in relation to the control or the window considered.

You can find out:

the position of the mouse (or stylus) when left-clicking in an Image control (function used in the "Click" event of the Image control).
the position of the mouse (or stylus) when hovering over a window (function used in the optional "Mouse hover" event of a window).

Used in a browser event (of an control or a page), returns the horizontal position (X) of the 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.
It is advisable to use this function only in events in fields hovered with 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 relative to the top left point of the hovered control (or of the window if the event is on the window).
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 control (relative to the top left corner of the Image control).

This constant should only be used when the function MouseXPos is called in an event associated with an Image control. Otherwise, MouseXPos will return -1.

This parameter is not available.
New in version 17
Marker used to calculate the position:
mpControl
(Default value) Mouse position relative to the top left point of the hovered control (or of the window if the event is on the window).
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 control (relative to the top left corner of the Image control).

This constant should only be used when the function MouseXPos is called in an event associated with an Image control. Otherwise, MouseXPos will return -1.

This parameter is not available.
Marker used to calculate the position:
mpControl
(Default value) Mouse position relative to the top left point of the hovered control (or of the window if the event is on the window).
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 control (relative to the top left corner of the Image control).

This constant should only be used when the function MouseXPos is called in an event associated with an Image control. Otherwise, MouseXPos will return -1.

This parameter is not available.

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 relative to the top left point of the hovered control (or of the page if no control is hovered and if the event is on the page).
If this constant is selected, MouseXPos must be used in the "OnClick" code of 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.
The function MouseXPos is not called in an linked event with the mouse.
The click code is executed by function Execute or ExecuteProcess.

Various

It is possible to know the vertical position of the mouse (or the stylus) thanks to the MouseYPos function.
MouseXPos used in the selection code of row or table always returns 0.
It is advisable to use this function only in WLanguage events associated with mouse-over fields.

Limits in browser code

The MouseXPos function is not available:

in 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 control..

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: wd260obj.dll