XenoGuard Documentation

Wait For Symbol

Actions » Windows » Screen » Wait For Symbol 

The action Wait For Symbol pauses the execution of a screen capture until the specified symbol appears or disappears on the screen. This action also returns the location (X and Y coordinates) and dimension (width and height) of the symbols found on the screen.

[-] Hide
  1. Open the Windows node in the Workspace Explorer.
  2. In the Screen node, select the Wait For Symbol action.

Parameters:

The action 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 Type [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]
Wait For Disappearance [ms]
Determines if the action should wait until the symbol disappears on the screen.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Data Type [Boolean]
Waiting Time for 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 Detection [ms]
The waiting time in milliseconds after the symbol has appeared on the screen.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Waiting Time After Disappearance [ms]
The waiting time in milliseconds after the symbol has disappeared on the screen.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]
Timeout [ms]
The timeout in milliseconds for the complete action.

Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter, Enum]

Information The Symbol To Detect allows you to "choose a file selection window" or "mark a region on the screen". 

Results:

The action 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:

  • X coordinate - the x-position of the symbol
  • Y coordinate - the y-position of the symbol
  • Width - the width of the symbol
  • Height - the height of the symbol
Allowed Context Scopes [Fixed, Local, Global]
Allowed Context Types [Variable, Parameter]

Warning An error occurs when an image is not defined in the Symbol to Detect parameter.

Example 1 (Find and open the created folder on the desktop):

This example creates a directory on the desktop and locates its x- and y-coordinates. The coordinates are then passed to set the location of the cursor on the desktop and opens the created directory using the Mouse Button Click


See other screen operations:

Take Screenshot
Mouse To Symbol
Xenoguard Window State