MouseYPos (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help

WLanguage

WLanguage functions

Standard functions

Windows management functions

Mouse functions

MouseYPos

Presentation

Example

Error

Miscellaneous

Related examples

See also

MouseYPos (Function)

In french: SourisPosY

Returns the vertical position (Y) of the mouse cursor relative to the specified window or control. Used in a mouse or stylus process (click, hover, left or right button down, etc.).

You can get:

the position of the mouse (or stylus) when an Image control is clicked (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)

Remarks:

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 MouseYPos() < 25 THEN
Info("At the top")
ELSE
Info("At the bottom")
END

Syntax

Retrieving the mouse position in a window Hide the details

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

<Result>: Integer

Vertical position (Y-coordinate) of the mouse or stylus, in pixels. By default, this position is relative to the upper-left corner of the control on which the left mouse button was pressed.
-1 if an error occurred.

<Marker>: Optional Integer constant

Marker used to calculate the position:
mpControl
(Default value) Mouse position relative to the upper-left corner of the control or window, depending on where the event occurs.
mpImage Mouse position in the image (relative to the upper-left corner of the image).

This constant should only be used when MouseYPos is called in an event associated with an Image control. Otherwise, MouseYPos will return -1.
mpScreen Mouse position in the screen (relative to the upper-left corner).
mpWindow Mouse position relative to the upper-left corner of the window.

Remarks

Error

The main error codes are as follows:

No window is opened.
No mouse click is performed.
MouseYPos is not called in a mouse event.
The click code is executed by Execute or ExecuteProcess.

Miscellaneous

You can get the horizontal position of the mouse or stylus with MouseXPos.
MouseYPos used in the selection code of row or table always returns 0.

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