Mouse to Symbol
ActionStep Reference » Windows » Screen » Mouse to Symbol
The Mouse to Symbol ActionStep moves the mouse cursor to hover over a detected symbol on the screen. Additionally, this ActionStep provides the location (X and Y coordinates) and dimensions (width and height) of any symbols found.
- Open the Windows node in the Workspace Explorer.
- In the Screen node, select the Mouse to Symbol ActionStep.
Parameters:
The ActionStep has the following input parameters:
| name |
Description
|
|---|---|
|
Screen
|
Specifies the screen where the symbol is to be searched.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
|
Region Left
|
Specifies the screen coordinates from the left of the screen.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Type [Variable, Parameter, Enum] |
|
Region Top
|
Specifies the screen coordinates from the top of the screen.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Type [Variable, Parameter, Enum] |
|
Region Width
|
Specifies the width of the region where the symbol can be located.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Type [Variable, Parameter, Enum] |
|
Region Height
|
Specifies the height of the region where the symbol can be located.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Type [Variable, Parameter, Enum] |
|
Symbol to Detect
|
Specifies the symbol to be searched on the screen.
Allowed Context Scopes [Fixed, Local, Global] Allowed Data Type [Image] |
|
Symbol Must Appear
|
Determines if the symbol should appear on the screen.
Allowed Context Scopes [Fixed, Local, Global] Allowed Data Type [Boolean] |
|
Mouse Button
|
Specifies which mouse button to press after detecting the symbol.
Accepted values for the Mous Button: [Left, Right, Middle, XButton1, XButton2 Allowed Context Scopes [Fixed, Local, Global]Allowed Context Types [Variable, Parameter, Enum] |
|
Mouse Speed [px/s]
|
Sets the speed of the mouse cursor on the screen in pixels per second.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable Parameter, Enum] |
|
Mouse Clicks
|
Sets the number of mouse clicks to simulate.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
|
X Offset [px]
|
Determines the mouse cursor offset position on the x-coordinate.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable Parameter, Enum] |
|
Y Offset [px]
|
Determines the mouse cursor offset position on the y-coordinate.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
|
Waiting TIme for Symbol Appearance [ms]
|
The time allocated in milliseconds for the symbol to appear on the screen.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
|
Waiting Time After Mouse Click [ms]
|
The waiting time in milliseconds after the mouse key has been pressed.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
|
Waiting Time After Mouse Button Release [ms]
|
The waiting time in milliseconds after the mouse key has been released.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter, Enum] |
|
The Symbol To Detect allows you to "choose a file selection window" or "mark a region on the screen". |
Results:
The ActionStep returns the following results:
|
name
|
description
|
|---|---|
|
Symbol Detected
|
Determines if the symbol appeared on the screen.
Allowed Context Scopes [Fixed, Local, Global] Allowed Value [Boolean] |
|
Number of Symbols |
The total number of symbols detected on the screen.
Allowed Context Scopes [Fixed, Local, Global] Allowed Context Types [Variable, Parameter] |
|
Matches |
The list of symbols detected on the screen.
Parameters of the Match sub-branch:
Allowed Context Types [Variable, Parameter] |
|
An error occurs when an image is not defined in the Symbol to Detect parameter. |
Example 1 (Stop the ActionStep when the mouse clicks the button):
This example waits for two seconds before the mouse cursor proceeds to the specified symbol on the screen. When the symbol is detected, the button is clicked and stops the execution of the ActionStep. The output is then displayed in a Message Box.
Example 2 (Rename a created folder on the desktop):
This example creates and renames a created folder on the desktop. The image of the created folder is searched on the desktop and once it is located the mouse cursor hovers on the image. The folder is then renamed to "Demo Folder" using Keyboard Write Text and output is then displayed in a Message Box.
