Subscribe

UiPath Activities

The UiPath Activities Guide

UiPath.UIAutomationNext.Activities.NClick

Description

Clicks a specified UI element, for example a button or a link. Can be configured to use any mouse button, use a double-click, and it can be used in combination with a key modifier. This activity must be added inside a Use Application/Browser activity.

Properties

Common

  • Continue on error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
  • Delay after - Delay (in seconds) between the time this activity is completed and the time the next activity begins any operations. The default value is 0.3 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • 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.
  • Timeout - Specify a number of seconds for which to wait for the activity to be executed before throwing an error. The default value is 30 seconds.

Input

  • Click type - Select the type of click to perform: Single, Double, Down, or Up. The default option is Single.
  • CursorMotionType - Specifies the type of motion performed by the mouse cursor. There are two available options:
    • Instant - The cursor jumps to the destination
    • Smooth - The cursor moves in increments. Has no effect if SendWindowMessages or SimulateClick are enabled. By default, Instant is selected.
  • Mouse button - Select the mouse button to click with: Left, Middle, or Right. The default option is Left.
  • 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.
  • Verify execution - At runtime, verifies if the action performed by the activity was correct. This is done by indicating an element that should appear or disappear after the action is performed, which is monitored and verified after the activity is executed. This feature can be enabled from the Project Settings, or from the body of the activity, by selecting Add Verification from the context menu.
    • Verify execution.Display name - The display name of the verification action. This field is autofilled based on the verification action and element you have chosen. Once Verify Execution is set up, this display name becomes visible in the lower part body of the activity, in the Workflow Designer.
    • Verify execution.Retry - When selected, the click is retried for the duration of the activity timeout, if the expected outcome was not achieved. By default, this check box is selected.
    • Verify execution.Target - This target is used to indicate the element that you want to verify at runtime. For more information on the property fields that can be expanded under this property, see the Target section above, as the functionality of the properties is the same.
    • Verify execution.Timeout - The amount of time (in seconds) to wait for the verification element to appear/disappear. If the Retry checkbox is selected, the action is performed again, followed by the verification, for the duration specified in the Timeout property of the activity.
    • Verify execution.Verify element - Defines what change you want to check the verification target for. The available options are Appeared, Disappeared, Text Changed, Visually Changed.

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

  • Input mode - Select how to execute the click:
    • Same as App/Browser - Use the same input mode as the Use Application/Browser activity. This is the default selection.
    • Window Messages - Simulates using Win32 messages. Recommended for desktop apps. Usually more reliable than Hardware Events. Sends all text in one go. Works even if the target application is not in focus. Before using this method, please test if your target application UI element supports this.
    • Edge Chromium API - Performs actions using debugger APIs. Works for Edge Chromium elements only. Sends all text in one go. Works even if the target application is not in focus.
    • Hardware Events - Simulates the click by using the hardware driver. This is the slowest method, it cannot work in the background, but it is compatible with all desktop apps. This option is selected by default if you change the default setting for any of the following properties ClickType, MouseButton, or KeyModifiers.
    • Simulate - Simulates the click using accessibility APIs. Recommended in browser automation, Java apps, or SAP. More reliable than Hardware Events. Works even if the target application is not in focus. Please test if your target application UI element supports this.

      Note:

      Simulate can only be used with the Single click type and the Left mouse button options.

  • Key modifiers - Add one or more key modifiers to use in combination with the click. The following options are available: None, Alt, Ctrl, Shift, and Win. The default option is None.

    Note:

    Key modifiers cannot be used with the Simulate input mode.

UiPath.UIAutomationNext.Activities.NClick

Description

Clicks a specified UI element, for example a button or a link. Can be configured to use any mouse button, use a double-click, and it can be used in combination with a key modifier. This activity must be added inside a Use Application/Browser activity.

To learn how to use this activity, see Tutorial: Working with UI Automation.

Configuring the Activity

In the Body of the Activity

  • Click Indicate target on screen to indicate the UI element to click.
  • Click type - Select the type of click to perform: Single, Double, Down, or Up. The default option is Single.
  • CursorMotionType - Specifies the type of motion performed by the mouse cursor. There are two available options:
    • Instant - The cursor jumps to the destination
    • Smooth - The cursor moves in increments. Has no effect if SendWindowMessages or SimulateClick are enabled. By default, Instant is selected.
  • Mouse button - Select the mouse button to click with: Left, Middle, or Right. The default option is Left.
  • 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

  • Continue on error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
  • Delay after - Delay (in seconds) between the time this activity is completed and the time the next activity begins any operations. The default value is 0.3 seconds. Adding a delay between activities ensures that one activity has enough time to complete before the next activity begins.
  • 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.
  • Timeout - Specify a number of seconds for which to wait for the activity to be executed before throwing an error. The default value is 30 seconds.

Input

Misc

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

Options

  • Input mode - Select how to execute the click:

    • Same as App/Browser - Use the same input mode as the Use Application/Browser activity. This is the default selection.
    • Hardware Events - Simulates the click by using the hardware driver. This is the slowest method, it cannot work in the background, but it is compatible with all desktop apps. This option is selected by default if you change the default setting for any of the following properties ClickType, MouseButton, or KeyModifiers.
    • Simulate - Simulates the click using the technology of the target application. This input method is the fastest and works in the background.

      Note:

      Simulate can only be used with the Single click type and the Left mouse button options.

  • Key modifiers - Add one or more key modifiers to use in combination with the click. The following options are available: None, Alt, Ctrl, Shift, and Win. The default option is None.

    Note:

    Key modifiers cannot be used with the Simulate input mode.

Updated about a month ago


Click


Suggested Edits are limited on API Reference Pages

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