Subscribe

UiPath Activities

The UiPath Activities Guide

Check App State

UiPath.UIAutomationNext.Activities.NCheckState

Description

Checks the state of an application or web browser by verifying if an element appears in or disappears from the user interface, and can execute one set of activities if the element is found and a different set of activities if the element is not found. Can also be used outside an Use Application/Browser activity.

Properties

Common

  • Delay before - Delay (in seconds) between the time the previous activity is completed and the time this activity begins performing any operations. The default value is 0.2 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • DisplayName - The name displayed for the activity in the Designer panel. A display name is automatically generated when you indicate a target.

Input

  • Target - Before indicating on screen the application you want to automate, this field is set to (null). Once the target is indicated, all properties regarding the element that was indicated are displayed.
    • Target.Check element visibility - If selected, checks whether the UI element is visible or not. By default, this check box is cleared.
    • Target.Click Offset - Specifies an offset for the click activity, which can be further configured.
    • Target.Click Offset.Anchoring Point - Describes the starting point of the cursor to which offsets from OffsetX and OffsetY properties are added. The following options are available: TopLeft, TopRight, BottomLeft, BottomRight, and Center. By default, Center is selected.
    • Target.Click Offset.OffsetX - Horizontal displacement of the cursor position according to the option selected in the Position field. This field supports only Int32 variables.
    • Target.Click Offset.OffsetY - VerticaldDisplacement of the cursor position according to the option selected in the Position field. This field supports only Int32 variables.
    • Target.Fuzzy selector - The parameters for the fuzzy selector.
    • Target.Native text - The text that is used to identify the target element.
    • Target.Selector - The selector that is generated for the indicated element.
    • Target.Targeting methods - The selector types that you want to use for identifying the element. This property can be set to any combination of Selector, Fuzzy selector, or Image.
    • Target.Wait for page load - Before performing the action, wait for the application to become ready to accept input. The following options are available:
      • None - Does not wait for the target to be ready.
      • Interactive - Waits until only a part of the app is loaded.
      • Complete - waits for the entire app to be loaded.
    • Target.Window selector (Application instance) - The selector that is used for the application window. Only applicable when the window attach mode is set to Application instance.

Input/Output Element

  • Input Element - The UI element on which the activity is executed, stored in an UIElement object. This field supports only UIElement objects. This object can be obtained from the Output Element property field of other UIAutomation activities.
  • Output Element - Outputs a target UI Element and stores it in a UIElement object, which can be further used to target the same element with other activities.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

  • Check visibility - If selected, the activity also checks if the target element is in the visible area of the user interface.
  • Timeout (seconds) - Specify the number of seconds for which to wait for the event (element to appear or to disappear). The default value is 5 seconds.
  • Wait for (appear/disappear) - Select which event to use for determining the state of the application or browser:
    • Element to appear - Wait for the element to appear in the user interface. If you select this option:
      • Add the activities to execute if the element appears in the Target appears block.
      • Add the activities to execute if the element does not appear in the Target does not appear block.
    • Element to disappear - Wait for the element to disappear from the user interface. If you select this option:
      • Add the activities to execute if the element disappears in the Target disappears block.
      • Add the activities to execute if the element does not disappear in the Target does not disappear block.

    Click Toggle Branches in the body of the activity to configure the visibility of the Target appears and Target does not appear containers where you can add activities to execute, depending on the state. You can work with both containers, either one of them, or none. By default, both blocks are visible.

Output

  • Result - Indicates if the element exists or not. The field supports only Boolean variables.

UiPath.UIAutomationNext.Activities.NCheckState

Description

Checks the state of an application or web browser by verifying if an element appears in or disappears from the user interface, and can execute one set of activities if the element is found and a different set of activities if the element is not found. Can also be used outside an Use Application/Browser activity.

Configuring the Activity

In the Body of the Activity

  • Click Indicate target on screen to indicate the UI element to verify.
  • Wait for - Select which event to use for determining the state of the application or browser:
    • Element to appear - Wait for the element to appear in the user interface. If you select this option:
      • Add the activities to execute if the element appears in the Target appears block.
      • Add the activities to execute if the element does not appear in the Target does not appear block.
    • Element to disappear - Wait for the element to disappear from the user interface. If you select this option:
      • Add the activities to execute if the element disappears in the Target disappears block.
      • Add the activities to execute if the element does not disappear in the Target does not disappear block.
  • Click Toggle Branches in the body of the activity to configure the visibility of the Target appears and Target does not appear containers where you can add activities to execute, depending on the state. You can work with both containers, either one of them, or none. By default, both blocks are visible.
  • Seconds - Click Plus plus button on the right side of the field, and then select Number to enter the number of seconds for which to wait for the event (element to appear or to disappear). The default value is 5 seconds. Alternatively, you can use one of the other options in the menu to enter the duration:
    • Data from the Project Notebook or a parent Excel file. For example, select an Excel file, and then select a cell that contains a number.
    • Ask when run - Prompt for a number when the project is executed.
    • Open in Advanced Editor - Enter a VB expression.
  • After you indicate the target, click Menu Options button to access the following options:
    • Indicate target on screen - Indicate the target again.
    • Edit Target - Open the selection mode to configure the target.

For more information about indicating and configuring targets, see About the UIAutomationNext Activities Pack.

In the Properties Panel

Common

  • Delay before - Delay (in seconds) between the time the previous activity is completed and the time this activity begins performing any operations. The default value is 0.2 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • DisplayName - The name displayed for the activity in the Designer panel. A display name is automatically generated when you indicate a target.

Misc

  • Private - If selected, the data used by the activity is not saved to the StudioX logs when the project is executed.

Options

Output

  • Result - A Boolean value (True/False) representing the result of the check. Optionally, you can save this value for later use, or save it in a cell in a parent Excel file or the Project Notebook.

Updated 3 months ago


Check App State


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.