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.
  • Mouse button - Select the mouse button to click with: Left, Middle, or Right. The default option is Left.

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.
    • 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.

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.
  • 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 19 days 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.