- Overview
- UI Automation
- Applications and technologies automated with UI Automation
- Project compatibility
- UI-ANA-016 - Pull Open Browser URL
- UI-ANA-017 - ContinueOnError True
- UI-ANA-018 - List OCR/Image Activities
- UI-DBP-006 - Container Usage
- UI-DBP-013 - Excel Automation Misuse
- UI-DBP-030 - Forbidden Variables Usage In Selectors
- UI-PRR-001 - Simulate Click
- UI-PRR-002 - Simulate Type
- UI-PRR-003 - Open Application Misuse
- UI-PRR-004 - Hardcoded Delays
- UI-REL-001 - Large Idx in Selectors
- UI-SEC-004 - Selector Email Data
- UI-SEC-010 - App/Url Restrictions
- UI-USG-011 - Non Allowed Attributes
- UX-SEC-010 - App/Url Restrictions
- UX-DBP-029 - Insecure Password Use
- UI-PST-001 - Audit Log Level in Project Settings
- UiPath Browser Migration Tool
- Clipping region
- Computer Vision Recorder
- Activate
- Anchor Base
- Attach Browser
- Attach Window
- Block User Input
- Callout
- Check
- Click
- Click Image
- Click Image Trigger
- Click OCR Text
- Click Text
- Click Trigger
- Close Application
- Close Tab
- Close Window
- Context Aware Anchor
- Copy Selected Text
- Element Attribute Change Trigger
- Element Exists
- Element Scope
- Element State Change Trigger
- Export UI Tree
- Extract Structured Data
- Find Children
- Find Element
- Find Image
- Find Image Matches
- Find OCR Text Position
- Find Relative Element
- Find Text Position
- Get Active Window
- Get Ancestor
- Get Attribute
- Get Event Info
- Get From Clipboard
- Get Full Text
- Get OCR Text
- Get Password
- Get Position
- Get Source Element
- Get Text
- Get Visible Text
- Go Back
- Go Forward
- Go Home
- Google Cloud Vision OCR
- Hide Window
- Highlight
- Hotkey Trigger
- Hover
- Hover Image
- Hover OCR Text
- Hover Text
- Image Exists
- Indicate On Screen
- Inject .NET Code
- Inject Js Script
- Invoke ActiveX Method
- Key Press Trigger
- Load Image
- Maximize Window
- Microsoft Azure Computer Vision OCR
- Microsoft OCR
- Microsoft Project Oxford Online OCR
- Minimize Window
- Monitor Events
- Mouse Trigger
- Move Window
- Navigate To
- OCR Text Exists
- On Element Appear
- On Element Vanish
- On Image Appear
- On Image Vanish
- Open Application
- Open Browser
- Refresh Browser
- Replay User Event
- Restore Window
- Save Image
- Select Item
- Select Multiple Items
- Send Hotkey
- Set Clipping Region
- Set Focus
- Set Text
- Set To Clipboard
- Set Web Attribute
- Show Window
- Start Process
- System Trigger
- Take Screenshot
- Tesseract OCR
- Text Exists
- Tooltip
- Type Into
- Type Secure Text
- Use Foreground
- Wait Attribute
- Wait Element Vanish
- Wait Image Vanish
- Application Event Trigger
- Check/Uncheck
- Check App State
- Check Element
- Click
- Click Event Trigger
- Close Popup
- Drag and Drop
- Extract Table Data
- For Each UI Element
- Get Attribute
- Get Browser Data
- Get Text
- Get URL
- Go to URL
- Highlight
- Hover
- Inject Js Script
- Keyboard Shortcuts
- Keypress Event Trigger
- Mouse Scroll
- Navigate Browser
- Select Item
- Set Browser Data
- Set Runtime Browser
- Set Text
- Take Screenshot
- Type Into
- Use Application/Browser
- Perform browser search and retrieve results using UI Automation APIs
- Web Browsing
- Find Images
- Click Images
- Trigger and Monitor Events
- Create and Override Files
- HTML Pages: Extract and Manipulate Information
- Window Manipulation
- Automated List Selection
- Find and Manipulate Window Elements
- Manage Text Automation
- Load and Process Images
- Manage Mouse Activated Actions
- Automate Application Runtime
- Automated Run of a Local Application
- Browser Navigation
- Web Automation
- Trigger Scope Example
- Computer Vision Local Server
- Mobile Automation
- Release notes
- Project compatibility
- Get Log Types
- Get Logs
- Get Page Source
- Get Device Orientation
- Get Session Identifier
- Install App
- Manage Current App
- Manage Other App
- Open DeepLink
- Open URL
- Mobile Device Connection
- Directional Swipe
- Draw Pattern
- Positional Swipe
- Press Hardware Button
- Set Device Orientation
- Take Screenshot
- Take Screenshot Part
- Element Exists
- Execute Command
- Get Attribute
- Get Selected Item
- Get Text
- Set Selected Item
- Set Text
- Swipe
- Tap
- Type Text
- Terminal
MouseScroll
Enables scrolling in applications by sending mouse scroll events to the specified UI element.
Namespace: UiPath.UIAutomationNext.API.Models
Assembly: UiPath.UIAutomationNext.API.Models (in UiPath.UIAutomationNext.API.Models dll)
Overload | Description |
---|---|
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. |
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.
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.
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).
- Timeout - Specifies the amount of time (in seconds)
to wait for the API to run before the
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.
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).
- Timeout - Specifies the amount of time (in seconds)
to wait for the API to run before the
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.
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).
- Timeout - Specifies the amount of time (in seconds)
to wait for the API to run before the
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.
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).
- Timeout - Specifies the amount of time (in seconds)
to wait for the API to run before the
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.
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.
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.
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.
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.
- Definition
- Overloads
MouseScroll(TargetAnchorableModel)
MouseScroll(TargetAnchorableModel, String)
MouseScroll(IElementDescriptor, MouseScrollOptions)
MouseScroll(TargetAnchorableModel, MouseScrollOptions)
MouseScroll(String, MouseScrollOptions)
MouseScroll(RuntimeTarget, MouseScrollOptions)
MouseScroll(String, String, NScrollDirection, Int32)
MouseScroll(IElementDescriptor, IElementDescriptor, NScrollDirection, Int32)
MouseScroll(String, NScrollDirection, Int32)
MouseScroll(IElementDescriptor, NScrollDirection, Int32)