activities
latest
false
UiPath logo, featuring letters U and I in white
UI Automation Activities
Last updated Nov 22, 2024

Find Text

UiPath.Terminal.Advanced.Activities.TerminalFindTextInScreen

Description

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

The activity is valid only inside a Terminal Session activity.

Project compatibility

Windows - Legacy | Windows

Configuration

Designer panel

  • Text - The text to be found on screen. This field supports only String variables and strings.
  • Ignore Case - When set to True, the search for the text on screen is case insensitive.

Properties panel

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 throws an InvalidCoordinates exception.
Options
  • DelayMS - Delay time (in milliseconds) after executing the activity. The default amount of time is 300 milliseconds (0.3 seconds).
  • IgnoreCase - When set to True, the search for the text on screen is 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 5000 milliseconds (5 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. The default value is READY.
    Note: The READY and COMPLETE 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.
  • Description
  • Project compatibility
  • Configuration

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.