Mouse Scroll

UiPath.UIAutomationNext.Activities.NMouseScroll

Description

Enables scrolling in applications by sending mouse scroll events to the specified UI element.

This activity must be added inside a Use Application/Browser activity.

To use this activity outside a Use Application/Browser activity, you need to provide an Input element.

This activity is compatible with Object Repository.

Note:

If no target is supplied for this activity, it automatically uses the target of the scope where it is included.

Also, due to the nature of this activity, it cannot be used in background mode.

For more information about indicating and configuring targets, see Selection Screen.

Project compatibility

Windows - Legacy | Windows | Cross-platform

Windows - Legacy, Windows configuration

Designer panel

• Select the Menu button to access the following options:

  • Indicate target on screen - Indicate the target again.
  • Edit target - Open the selection mode to configure the target.
  • Remove informative screenshot - Remove the screenshot of the target application or web page.
  • Add to Object Repository - Add the current UI element to a library project, from where it can be reused throughout your automation process.

• Direction - The direction in which you want the scroll to be performed. The following options are available: Left, Up, Right, Down. The default option is Down.

• Scroll type - Select between the two methods of use for this activity:

  • To element - Scrolls until a specified UI element is found in the target application. This is the default option.

    Note: If you select To Element in the Scroll Type field, the # of scrolls property field is ignored, and the specified UI element is looked for.

    If, at runtime, the indicated element is not found, the activity scrolls for as much as specified in the # of scrolls field and then retries the search for the indicated element. This behavior is repeated as many times as necessary, until the element is found, and can be useful in the case of applications that have longer loading times.

  • Distance - Only scrolls as much as specified in the # of scrolls property field.

    Note: The number of lines scrolled by a scroll movement is configured in the Mouse settings section in Windows. If scrolling to a specific element, the element is searched after all rotations are executed. Selecting this method also displays the # of scrolls property in the body of the activity.

• Scroll to element - Click Indicate in App/Browser to indicate the UI element that you want to scroll to. This option appears only if To element is selected from the Scroll type drop-down menu.

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.

• Display name - The name displayed for the activity in the Designer panel. A display name is automatically generated when you indicate a target.

• Timeout - Specify the amount of time (in seconds) to wait for the activity to be executed before throwing an error. The default value is 30 seconds.

  Important: If you are scrolling to an image target, it is recommended to increase the value of the Timeout property to accommodate for the longer image search times.

Input

• Cursor motion type - Specifies the type of motion performed by the mouse cursor. There are two available options:

  • Instant - The cursor jumps to the destination. This is the default option.
  • Smooth - The cursor moves in increments. The setting has effect only if the Hardware events input mode is used.
• Target - The target element. Target element must be set. Before indicating on screen, this field is set to (null). Once the target is indicated, all properties regarding the element that was indicated are displayed.
  • Click offset - Specifies an offset for the click activity, which can be further configured.
    • Anchoring point - Describes the starting point of the cursor to which it offsets from Offset X and Offset Y properties are added. The following options are available: TopLeft, TopRight, BottomLeft, BottomRight, and Center. By default, Center is selected.
    • Offset X - Horizontal displacement of the cursor position according to the option selected in the Anchoring point field. This field supports only Int32 variables.
    • Offset Y - Vertical displacement of the cursor position according to the option selected in the Anchoring point field. This field supports only Int32 variables.
  • CV Control type - Indicates the type of control identified using Computer Vision.
  • CV Text - Indicates the text identified using Computer Vision.
  • Fuzzy selector - The parameters for the fuzzy selector.
  • Native text - The text that is used to identify the UI element.
  • Responsive websites - Enable responsive websites layout.
  • Strict selector - The strict selector generated for the UI element.
  • Targeting methods - The selector types that you want to use for identifying the element. This property can be set to any combination from the drop-down menu:
    • None
    • Strict selector
    • Fuzzy selector
    • Image
    • Native text
    • Computer Vision - To use Computer Vision as a targeting method, you need to go to Project Settings > Computer Vision and make sure to set the correct server endpoint. You can leave this field as it is and use UiPath Cloud, which is filled-in by default, or you can enter another value either by selecting any of the other public endpoints specific to a server region or your own on-premises server.

      Another way of using Computer Vision as a targeting method is to set Use Local Server to True. This implies that the UiPath.ComputerVision.LocalServer package is installed in your project. When Local Server is enabled, the server value is over-written. However, the Local Server is not available in cross-platform projects.

  • Visibility check - Checks whether the UI element is visible or not. You can choose one of three options from the drop-down menu:
    • None - Does not check for visibility.
    • Interactive (for Fuzzy Selector) - Default option. Checks if the element is potentially visible, ignoring page scroll and obstructions by other apps, or the fact that the application is minimized. This check is useful when trying to ensure that you are not targeting invisible elements that exist in the DOM but are hidden.
    • Fully visible - Checks if the UI element is visible or not.
  • Wait for page load - Before performing the action, wait for the application to become ready to accept input. You can choose one of three options from the drop-down menu:
    • 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.
  • 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 UI Automation 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. This field supports only Boolean (True, False) values. The default value is False.

Options

• # of scrolls - The amount of times to scroll, stored in an Int32 variable. If the Scroll type in the body of the activity is set to To element, this field is set by default to 10. If set to Distance, this field is set to 5 by default.
• Direction - See Direction in the Designer panel.

• Input mode - Select which method the Robot should use to interact with the target application:

  • Same as App/Browser - Use the same input mode as the Use Application/Browser activity.

  • Hardware Events - Uses the hardware driver to perform the action. This is the slowest method, it cannot work in the background, but it is compatible with all desktop apps.

  • Chromium API - Performs actions using debugger APIs. Works only for Chromium elements. Sends all text in one go. Works even if target app is not in focus. For more details, check out this page.

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

• Searched element - The indicated UI element that you want to scroll to.

  • Output element - The searched UI element reference, which you can use in other UI Automation activities, in the Input Element property.
  • Target - This UI element has its own Target property that can be configured the same as the main one.
  • Timeout - The amount of time (in seconds) to wait for the searched element to appear. The default value is 0.2 seconds.

Cross-platform configuration

• Work in scope - Choose the browser tab rendering the web application to automate.
• Scroll container - Scroll the Entire page or inside an Element. The default option is Entire page.
• Scroll direction - The direction in which you want the scroll to be performed. The following options are available: Left, Up, Right, Down. The default option is Down.
• Scroll type - Select between the two methods of use for this activity:
  • To element - Scrolls until a specified UI element is found in the target application. This is the default option.
  • Distance - Only scrolls as much as specified in the Number of scrolls property field.

• Indicate searched element on screen - Indicate the UI element that you want to scroll to. This option appears only if To element is selected from the Scroll type drop-down menu.

  After you indicate the target, select the plus button to access the following options:

  • Indicate target on screen - Indicate the target again.
  • Edit target - Open the selection mode to configure the target.

• Number of scrolls - The amount of times to scroll. This option appears only if Distance is selected from the Scroll type drop-down menu.

Additional options

Timings

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

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

• Timeout - Specify the amount of time (in seconds) to wait for the activity to be executed before throwing an error. The default value is 30 seconds.

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

Input/Output

• 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 UI Automation 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.
• Output searched element - The searched UI element reference, to use in other activities as Input UI element. This option appears only if To element is selected from the Scroll type drop-down menu.