UiPath Activities

The UiPath Activities Guide

Highlight

UiPath.UIAutomationNext.Activities.NHighlight

Description

Visually highlights a specified UI element by surrounding it in a box. 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.

Misc

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

Options

  • Color - Select the color of the box that surrounds the highlighted element. The default value is Gold.
  • Duration - The number of seconds for which to highlight the target element. The default value is 2 seconds.

UiPath.UIAutomationNext.Activities.NHighlight

Description

Visually highlights a specified UI element by surrounding it in a box. This activity must be added inside a Use Application/Browser activity.

Configuring the Activity

In the Body of the Activity

  • Click Indicate target on screen to indicate the UI element to highlight.
  • Duration - Click Plus plus button on the right side of the field, and then select Number to enter the number of seconds for which to highlight the target element. The default value is 2 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

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

Misc

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

Options

  • Color - Select the color of the box that surrounds the highlighted element. The default value is Gold.
  • Duration - See Duration in the body of the activity.

Updated 19 days ago


Highlight


Suggested Edits are limited on API Reference Pages

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