OverviewExamples
table System.GetMousePosition ( |
Returns a table containing the current position of the mouse, either relative to the entire screen (screen coordinates) or relative to the application (client coordinates).
Note: Screen coordinates are relative to the top left corner of the screen. Client coordinates are relative to the top left corner of the application's client area (the page).
(boolean) Whether to get the mouse position relative to the application:
VALUE |
DESCRIPTION |
true |
Return the current position of the mouse relative to the application (client coordinates). (Default) |
false |
Return the current position of the mouse relative to the screen (screen coordinates). |
(table) A table containing the current position of the mouse, either relative to the entire screen (screen coordinates) or relative to the application (client coordinates), indexed by the following keys:
KEY |
TYPE |
DESCRIPTION |
X |
number |
The horizontal position of the mouse cursor. |
Y |
number |
The vertical position of the mouse cursor. |
If this information cannot be determined, or an error occurs, nil is returned. You can use Application.GetLastError to determine whether this action failed, and why.
When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions