activities
latest
false
- 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
- 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
- Enable UI Automation support in DevExpress
- 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
UI Automation Activities
Last updated Dec 4, 2024
UI Automation APIs
APIs allow you to access and interact with the services offered in the
Manage Packages menu. You can use these APIs when you design coded
automations. Visit Coded Automations to learn about coded automations and how
to design them using APIs.
Note: Using Go to Definition
(
F12) allows you to access the definition of UiPath APIs for a
certain service. We recommend relying only on the directly exposed APIs when you
implement coded automations. Other APIs that are not directly exposed with a service
are subject to change without prior notification.
APIs often have overloads, which means they provide multiple versions of the same method with different parameter options. Overloads allow you to customize the behavior of the API based on your specific requirements. For example, a UI Automation API may have an overload that accepts a timeout parameter to specify the maximum time to wait for a UI element to appear before ending execution.
By using the APIs with their respective overloads, you can easily achieve your desired automation logic and behavior.
This section includes the APIs found in the UiPath.UIAutomationNext.API.Contracts
service.
| API | Description |
|---|---|
| Attach | Focuses on a desktop application or web browser page that's already open, to use in UI Automation. |
| Check | Selects or clears a check box or a radio button. |
| Click | Clicks a specified UI element, for example a button or a link. You can further configure the click action, according to your use case. |
| ClosePopup | Dismisses all pop-ups that are on top of the application. |
| DragAndDrop | Executes a drag and drop operation from the source UI element to the destination UI element. |
| ExtractData | Extracts data as data table. |
| GetAttribute | Retrieves the value of a specified attribute of the indicated UI element. |
| GetChildren | Retrieves the children of a specified target. |
| GetRuntimeTarget | Retrieves the runtime target of a specified target. |
| GetText | Extracts and copies the text from a UI element. |
| GetUrl | Retrieves the URL from the current web page. |
| GoToUrl | Navigates to the specified URL in the indicated web browser. |
| Highlight | Visually highlights a specified UI element by surrounding it in a box. |
| Hover | Retrieves the URL from the current web page. |
| IsEnabled | Checks if an UI element is enabled. |
| KeyboardShortcut | Sends one or more keyboard shortcuts to a UI element. |
| MouseScroll | Enables scrolling in applications by sending mouse scroll events to the specified UI element. |
| Open | Opens a desktop application or web browser page to use in UI automation. |
| SelectItem | Selects an item from a drop-down combo box or list box. |
| SetRuntimeBrowser | Sets the currently active runtime browser. |
| SetValue | Sets a value on any input field: input box, drop-down, check box, radio button. |
| TakeScreenshot | Takes a screenshot of a specified UI element or application and saves it to a file. |
| TypeInto | Enters text in a specified UI element, for example a text box. You can also send special keys like Tab or Enter to the UI element. |
| WaitState | Checks the state of an application or web browser by verifying if an element appears in or disappears from the user interface. |
You can use UI Automation APIs in combination with UI elements. The process of automating UI applications involves opening the desire application or focusing on it, then automating its UI elements. Perform the following steps to automate an application using UI Automation APIs:
- Call the UI Automation service, when you use the Attach and Open APIs. These
APIs are used on their own, to open or focus on an application or web
browser.
- When working with UI elements captured in the Object Repository as
descriptors, employ the Open or Attach API with the
IScreenDescriptoroverload:uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>) - For native selectors,
copy the
<app/>tag of the application using the UI Explorer and utilize the Open API with theTargetAppModeloverload:var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"))
- When working with UI elements captured in the Object Repository as
descriptors, employ the Open or Attach API with the
- Call the UI Automation APIs directly on a UI element.
- When working with UI elements captured in the Object Repository as
descriptors, employ the rest of the APIs with the
IElementDescriptoroverload:var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>) applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello")var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>) applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello") - For native selectors copy the
<webctrl/>tag of the element using the UI Explorer, and employ the rest of the APIs with theTargetAnchorableModeloverloads:var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>")); applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>")); applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")
- When working with UI elements captured in the Object Repository as
descriptors, employ the rest of the APIs with the
