- Overview
- UI Automation
- About the UI Automation activity package
- 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-DBP-031 - Activity verification
- 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
- Activities index
- 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
- Accessibility Check
- Application Event Trigger
- Block User Input
- Check/Uncheck
- Check App State
- Check Element
- Click
- Click Event Trigger
- Drag and Drop
- Extract Table Data
- Find Elements
- For Each UI Element
- Get Browser Data
- Get Clipboard
- 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 Clipboard
- Set Runtime Browser
- Set Focus
- Set Text
- Take Screenshot
- Type Into
- Unblock User Input
- Use Application/Browser
- Window Operation
- 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
- Enable UI Automation support in DevExpress
- Computer Vision Local Server
- Mobile Automation
- Release notes
- About the mobile device automation architecture
- 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
- Release notes
- About the Terminal activity package
- Project compatibility
- Best practices
- Find Text
- Get Color at Position
- Get Cursor Position
- Get Field
- Get Field at Position
- Get Screen Area
- Get Text
- Get Text at Position
- Move Cursor
- Move Cursor to Text
- Send Control Key
- Send Keys
- Send Keys Secure
- Set Field
- Set Field at Position
- Terminal Session
- Wait Field Text
- Wait Screen Ready
- Wait Screen Text
- Wait Text at Position

UI Automation activities
Click
Clicks a specified UI element, for example a button or a link. Can be configured to use any mouse button, use a double-click.
Definition
Namespace: UiPath.UIAutomationNext.API.Models
Assembly: UiPath.UIAutomationNext.API.Models (in UiPath.UIAutomationNext.API.Models dll)
Overloads
| Overload | Description |
|---|---|
Click(String, ClickOptions) | Clicks a UI element identified by a string in the Object Repository. |
Click(IElementDescriptor, ClickOptions) | Clicks a UI element identified by a descriptor of an element from Object Repository. |
Click(TargetAnchorableModel, ClickOptions) | Clicks a target anchorable model, which represents a specific UI element in the application. |
Click(RuntimeTarget, ClickOptions) | Clicks a UI element identified by a runtime instance of an Object Repository element. |
Click(String, NClickType, NMouseButton) | Performs a click operation on a UI element identified by a string in the Object Repository, specifying the click type and mouse button. |
Click(IElementDescriptor, NClickType, NMouseButton) | Clicks a UI element identified by a descriptor of an element from Object Repository, specifying the click type and mouse button. |
Click(String, ClickOptions)
Clicks a UI element identified by its string representation.
Click(
TargetAnchorableModel target,
ClickOptions clickOptions)
Click(
TargetAnchorableModel target,
ClickOptions clickOptions)
target String
: Indicate the UI element captured in the Object Repository that you want to
click.
clickOptions ClickOptions
: Additional options for customizing the click operation:
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType
CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode
NInteractionMode`:
+ `HardwareEvents` - Simulates the click
by using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode
as the Open or Attach APIs. This is the default
selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType
CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode
NInteractionMode`:
+ `HardwareEvents` - Simulates the click
by using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode
as the Open or Attach APIs. This is the default
selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
Click(IElementDescriptor, ClickOptions)
Clicks a UI element identified by a descriptor of an element from Object Repository.
Click(
IElementDescriptor elementDescriptor,
ClickOptions clickOptions)
Click(
IElementDescriptor elementDescriptor,
ClickOptions clickOptions)
elementDescriptor IElementDescriptor
: The UI element you want to click, identified by a descriptor of an element from
Object Repository.
clickOptions ClickOptions
: Additional options for customizing the click operation:
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType
NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType
CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode
NInteractionMode`:
+ `HardwareEvents` - Simulates the click
by using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode
as the Open or Attach APIs. This is the default
selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType
NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType
CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode
NInteractionMode`:
+ `HardwareEvents` - Simulates the click
by using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode
as the Open or Attach APIs. This is the default
selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
Click(TargetAnchorableModel, ClickOptions)
Clicks a target anchorable model, which represents a specific UI element in the application.
Click(
TargetAnchorableModel target,
ClickOptions clickOptions)
Click(
TargetAnchorableModel target,
ClickOptions clickOptions)
target TargetAnchorableModel
: The target anchorable model (UI element) that you want to click.
clickOptions ClickOptions
: Additional options for customizing the click operation:
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode NInteractionMode`:
+ `HardwareEvents` - Simulates the click by
using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode as the
Open or Attach APIs. This is the default selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode NInteractionMode`:
+ `HardwareEvents` - Simulates the click by
using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode as the
Open or Attach APIs. This is the default selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
Click(RuntimeTarget, ClickOptions)
Clicks a UI element identified by a runtime instance of an Object Repository element.
Click(
RuntimeTarget target,
ClickOptions clickOptions)
Click(
RuntimeTarget target,
ClickOptions clickOptions)
target RuntimeTarget
: The UI element you want to click, identified by a runtime instance of an Object
Repository element.
clickOptions ClickOptions
: Additional options for customizing the click operation:
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType
NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType
CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode
NInteractionMode`:
+ `HardwareEvents` - Simulates the click
by using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode
as the Open or Attach APIs. This is the default
selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
* `KeyModifiers NKeyModifiers`:
+ `None`
+ `Alt`
+ `Ctrl`
+ `Shift`
+ `Win`
* `ClickType
NClickType`:
+ `Single`
+ `Double`
+ `Down`
+ `Up`
For example, to perform a double click you just need to set
the click type to
`NClickType.Double`:
`clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest,
new ClickOptions(){ClickType =
NClickType.Double}.WithVariable("account_number_system1",
"407547"));`.
* `MouseButton NMouseButton`:
+ `Left`
+ `Right`
+ `Middle`
* `CursorMotionType
CursorMotionType`:
+ `Instant` - The cursor jumps to the
destination.
+ `Smooth` - The cursor moves in
increments.
* `InteractionMode
NInteractionMode`:
+ `HardwareEvents` - Simulates the click
by using the hardware driver. This is the slowest API, it
cannot work in the background, but it is compatible with all
desktop apps.
+ `SameAsCard` - Use the same input mode
as the Open or Attach APIs. This is the default
selection.
+ `Simulate` - Simulates the click using
accessibility APIs. Recommended in browser automation, Java
apps, or SAP. More reliable than Hardware Events. Works even
if the target application is not in focus. Please test if
your target application UI element supports this.
+ `DebuggerApi` - Performs actions using
debugger APIs. Works for Chromium elements only. Sends all
text in one go. Works even if the target application is not
in focus. For more details, check out this [page](https://docs.uipath.com/studio/standalone/2023.10/user-guide/chromium-api).
+ `WindowMessages` - Simulates using Win32
messages. Recommended for desktop apps. Usually more
reliable than Hardware Events. Sends all text in one go.
Works even if the target application is not in focus. Before
using this API, please test if your target application UI
element supports this.
Click(String, NClickType, NMouseButton)
Perform a click operation on a UI element identified by its string representation or selector, specifying the click type and mouse button.
Click(
string target,
NClickType clickType,
NMouseButton mouseButton)
Click(
string target,
NClickType clickType,
NMouseButton mouseButton)
target String
: Indicate the UI element captured in the Object Repository that you want to
click.
clickType NClickType
: The type of click to perform: Single, Double, Down, or
Up. The default option is Single.
: For example, to perform a double click you just need to set the click
type to NClickType.Double:clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest, new ClickOptions(){ClickType = NClickType.Double}.WithVariable("account_number_system1", "407547"));.
mouseButton NMouseButton
: The mouse button to click with: Left, Middle, or Right.
The default option is Left.
Click(IElementDescriptor, NClickType, NMouseButton)
Clicks a UI element identified by a descriptor of an element from Object Repository, specifying the click type and mouse button.
Click(
IElementDescriptor elementDescriptor,
NClickType clickType,
NMouseButton mouseButton)
Click(
IElementDescriptor elementDescriptor,
NClickType clickType,
NMouseButton mouseButton)
elementDescriptor IElementDescriptor
: The UI element you want to click, identified by a descriptor of an element
from Object Repository.
clickType NClickType
: The type of click to perform: Single, Double, Down, or
Up. The default option is Single.
: For example, to perform a double click you just need to set the click
type to NClickType.Double:clientAccountsScreen.Click(Descriptors.ACME_System_3.ClientAccountsScreen.AccountRowTest, new ClickOptions(){ClickType = NClickType.Double}.WithVariable("account_number_system1", "407547"));.
mouseButton NMouseButton
: The mouse button to click with: Left, Middle, or Right.
The default option is Left.