Find Text

UiPath.Terminal.Advanced.Activities.TerminalFindTextInScreen

Description

Finds the first occurrence of the text provided as input and returns the screen coordinates.

Project compatibility

Windows - Legacy | Windows

Properties

Common

• DisplayName - The display name of the activity.

Input

• Start Column - The column coordinate of the position on the screen where the search starts from. This field supports only integer and Int32 variables.
• Start Row - The row coordinate of the position on the screen where the search starts from. This field supports only integer and Int32 variables.

• Text - The text to be found on screen. This field supports only string variables and strings.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
  Note: If the text provided as input is not found on screen, the activity will throw an InvalidCoordinates exception.

Options

• DelayMS - Delay time (in milliseconds) after executing the activity. The default amount of time is 300 milliseconds.
• IgnoreCase - When set to true, the search for the text on screen will be case insensitive.
• TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).
• WaitType - Before performing the actions, wait for the target to become ready. The following options are available:
  • None - Does not wait for the terminal keyboard to be enabled.
  • Ready / Complete - Waits for the terminal keyboard to be enabled.
  Note: The Ready and Complete WaitType options have the same function, since the wait type is related to the status of the terminal keyboard (which has only two states: enabled or inhibited).

Output

• Column - The column where the first occurrence of the text provided as input was found. The return value is an Int32.
• Row - The row where the first occurrence of the text provided as input was found. The return value is an Int32.