activities
latest
false
UiPath logo, featuring letters U and I in white

UI Automation activities

Last updated Feb 19, 2026

MouseScroll

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

This API must be added after Open or Attach.

Definition​

Namespace: UiPath.UIAutomationNext.API.Models

Assembly: UiPath.UIAutomationNext.API.Models (in UiPath.UIAutomationNext.API.Models dll)

Overloads​

OverloadDescription
MouseScroll(TargetAnchorableModel)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by the TargetAnchorableModel object.
MouseScroll(TargetAnchorableModel, String)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by the TargetAnchorableModel object, while specifying the target to scroll into.
MouseScroll(IElementDescriptor, MouseScrollOptions)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a descriptor of an element from Object Repository, while customizing the mouse scroll action.
MouseScroll(TargetAnchorableModel, MouseScrollOptions)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by the TargetAnchorableModel object, while customizing the mouse scroll action.
MouseScroll(String, MouseScrollOptions)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a string from Object Repository, while customizing the mouse scroll action.
MouseScroll(RuntimeTarget, MouseScrollOptions)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a runtime instance of an Object Repository element, while customizing the mouse scroll action.
MouseScroll(String, String, NScrollDirection, Int32)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a string from Object Repository, while specifying the target to scroll into, the scroll direction, and the number of mouse wheel detents.
MouseScroll(IElementDescriptor, IElementDescriptor, NScrollDirection, Int32)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a descriptor of an element from Object Repository, while specifying the element descriptor to scroll into, the scroll direction, and the number of mouse wheel detents.
MouseScroll(String, NScrollDirection, Int32)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a string from Object Repository, while specifying the scroll direction and the number of mouse wheel detents.
MouseScroll(IElementDescriptor, NScrollDirection, Int32)Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a descriptor of an element from Object Repository, while specifying the scroll direction, and the number of mouse wheel detents.

MouseScroll(TargetAnchorableModel)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by the TargetAnchorableModel object.

MouseScroll(
    TargetAnchorableModel target)
MouseScroll(
    TargetAnchorableModel target)

target TargetAnchorableModel : The UI element that you send mouse scroll events to, identified by the TargetAnchorableModel object.

MouseScroll(TargetAnchorableModel, String)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by the TargetAnchorableModel object, while specifying the target to scroll into.

MouseScroll(
    TargetAnchorableModel target,
    string searchedTarget)
MouseScroll(
    TargetAnchorableModel target,
    string searchedTarget)

target TargetAnchorableModel : The UI element that you send mouse scroll events to, identified by the TargetAnchorableModel object.

searchedTarget String : The target to scroll into, identified by a string from Object Repository.

MouseScroll(IElementDescriptor, MouseScrollOptions)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a descriptor of an element from Object Repository, while customizing the mouse scroll action.

MouseScroll(
    IElementDescriptor elementDescriptor,
    MouseScrollOptions mouseScrollOptions)
MouseScroll(
    IElementDescriptor elementDescriptor,
    MouseScrollOptions mouseScrollOptions)

elementDescriptor IElementDescriptor : The UI element that you send mouse scroll events to, identified by a descriptor of an element from Object Repository.

mouseScrollOptions MouseScrollOptions : Additional options to customize the mouse scroll action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.

MouseScroll(TargetAnchorableModel, MouseScrollOptions)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by the TargetAnchorableModel object, while customizing the mouse scroll action.

MouseScroll(
    TargetAnchorableModel target,
    MouseScrollOptions mouseScrollOptions)
MouseScroll(
    TargetAnchorableModel target,
    MouseScrollOptions mouseScrollOptions)

target TargetAnchorableModel : The UI element that you send mouse scroll events to, identified by the TargetAnchorableModel object.

mouseScrollOptions MouseScrollOptions : Additional options to customize the mouse scroll action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.

MouseScroll(String, MouseScrollOptions)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a string from Object Repository, while customizing the mouse scroll action.

MouseScroll(
    string target,
    MouseScrollOptions mouseScrollOptions)
MouseScroll(
    string target,
    MouseScrollOptions mouseScrollOptions)

target String : The UI element that you send mouse scroll events to, identified by a string from Object Repository.

mouseScrollOptions MouseScrollOptions : Additional options to customize the mouse scroll action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.

MouseScroll(RuntimeTarget, MouseScrollOptions)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a runtime instance of an Object Repository element, while customizing the mouse scroll action.

MouseScroll(
    RuntimeTarget target,
    MouseScrollOptions mouseScrollOptions)
MouseScroll(
    RuntimeTarget target,
    MouseScrollOptions mouseScrollOptions)

target RuntimeTarget : The UI element that you send mouse scroll events to, identified by a runtime instance of an Object Repository element.

mouseScrollOptions MouseScrollOptions : Additional options to customize the mouse scroll action. You can choose to customize:

* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.
* `TargetOptions`:
  + **Timeout** - Specifies the amount of time (in seconds)
    to wait for the API to run before the
    `SelectorNotFoundException` error is
    thrown. The default value is 30 seconds.
  + **DelayAfter** - Delay time (in seconds) after executing
    the API. The default amount of time is 0.3 seconds (300
    milliseconds).
  + **DelayBefore** - Delay time (in seconds) before the API
    begins performing any operations. The default amount of time
    is 0.2 seconds (200 milliseconds).
* `NChildInteractionMode` - The type of the interaction
  to use performing the actions.
* `CusorMotionType` - Specifies the type of motion
  performed by the mouse cursor. There are two available options:
  + **Instant** - The cursor jumps to the destination. By
    default, **Instant** is selected.
  + **Smooth** - The cursor moves gradually towards the
    destination.
* `NKeyModifiers` - Add one or more key modifiers to
  use in combination with the scroll. The following options are
  available: **None**, **Alt**, **Ctrl**, **Shift**, and
  **Win**. The default option is **None**.
* `NScrollDirection` - The direction in which you want
  the scroll to be performed. The following options are available:
  **Left**, **Up**, **Right**, **Down**.
* `MovementUnits` - The amount of mouse wheel detents
  you want to scroll. The default is set to 10.
* `SearchedElementOptions` - The indicated UI element
  that you want to scroll to.

MouseScroll(String, String, NScrollDirection, Int32)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a string from Object Repository, while specifying the target to scroll into, the scroll direction, and the number of mouse wheel detents.

MouseScroll(
    string target,
    string searchedTarget,
    [NScrollDirection direction],
    [int movementUnits])
MouseScroll(
    string target,
    string searchedTarget,
    [NScrollDirection direction],
    [int movementUnits])

target String : The UI element that you send mouse scroll events to, identified by a string from Object Repository.

searchedTarget String : The target to scroll into, identified by a string from Object Repository.

direction NScrollDirection : The direction in which you want the scroll to be performed. The following options are available: Left, Up, Right, Down.

movementUnits Int32 : The amount of mouse wheel detents you want to scroll. The default is set to 10.

MouseScroll(IElementDescriptor, IElementDescriptor, NScrollDirection, Int32)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a descriptor of an element from Object Repository, while specifying the element descriptor to scroll into, the scroll direction, and the number of mouse wheel detents.

MouseScroll(
    IElementDescriptor elementDescriptor,
    IElementDescriptor searchedelementDescriptor,
    [NScrollDirection direction],
    [int movementUnits])
MouseScroll(
    IElementDescriptor elementDescriptor,
    IElementDescriptor searchedelementDescriptor,
    [NScrollDirection direction],
    [int movementUnits])

elementDescriptor IElementDescriptor : The UI element that you send mouse scroll events to, identified by a descriptor of an element from Object Repository.

searchedelementDescriptor IElementDescriptor : The element descriptor to scroll into.

direction NScrollDirection : The direction in which you want the scroll to be performed. The following options are available: Left, Up, Right, Down.

movementUnits Int32 : The amount of mouse wheel detents you want to scroll. The default is set to 10.

MouseScroll(String, NScrollDirection, Int32)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a string from Object Repository, while specifying the scroll direction and the number of mouse wheel detents.

MouseScroll(
    string target,
    [NScrollDirection direction],
    [int movementUnits])
MouseScroll(
    string target,
    [NScrollDirection direction],
    [int movementUnits])

target String : The UI element that you send mouse scroll events to, identified by a string from Object Repository.

direction NScrollDirection : The direction in which you want the scroll to be performed. The following options are available: Left, Up, Right, Down.

movementUnits Int32 : The amount of mouse wheel detents you want to scroll. The default is set to 10.

MouseScroll(IElementDescriptor, NScrollDirection, Int32)​

Enables scrolling in applications by sending mouse scroll events to the specified UI element, identified by a descriptor of an element from Object Repository, while specifying the scroll direction, and the number of mouse wheel detents.

MouseScroll(
    IElementDescriptor elementDescriptor,
    [NScrollDirection direction],
    [int movementUnits])
MouseScroll(
    IElementDescriptor elementDescriptor,
    [NScrollDirection direction],
    [int movementUnits])

elementDescriptor IElementDescriptor : The UI element that you send mouse scroll events to, identified by a descriptor of an element from Object Repository.

direction NScrollDirection : The direction in which you want the scroll to be performed. The following options are available: Left, Up, Right, Down.

movementUnits Int32 : The amount of mouse wheel detents you want to scroll. The default is set to 10.

Was this page helpful?

Support and Services
Get The Help You Need
UiPath Academy
Learning RPA - Automation Courses
UiPath Forum
UiPath Community Forum
Uipath Logo
Trust and Security
Terms of Use
Privacy Policy
Cookies Policy
© 2005-2026 UiPath. All rights reserved.