- Release notes
- 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
- ST-DBP-021 - Hardcoded Timeout
- 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
- SY-USG-013 - Private File Invoke
- SY-USG-014 - Incorrect Execution Template Placeholders
- Applications and technologies automated with UI Automation
- UiPath Browser Migration Tool
- Computer Vision Recorder
- Click
- Hover
- Type Secure Text
- Send Hotkey
- Type Into
- Check
- Select Item
- Select Multiple Items
- Get Text
- Set Text
- Activate
- Highlight
- Set Focus
- Anchor Base
- Context Aware Anchor
- Find Relative Element
- Indicate On Screen
- Element Exists
- Find Element
- Wait Element Vanish
- Find Children
- Get Ancestor
- Element Scope
- Get Attribute
- Set Clipping Region
- Get Position
- Take Screenshot
- Wait Attribute
- On Element Appear
- On Element Vanish
- Click Text
- Hover Text
- Find Text Position
- Get Full Text
- Get Visible Text
- Extract Structured Data
- Text Exists
- Click OCR Text
- Hover OCR Text
- Get OCR Text
- Find OCR Text Position
- Microsoft OCR
- Microsoft Project Oxford Online OCR
- Microsoft Azure Computer Vision OCR
- Tesseract OCR
- Google Cloud Vision OCR
- OCR Text Exists
- Click Image
- Hover Image
- Find Image Matches
- Image Exists
- Find Image
- Wait Image Vanish
- On Image Appear
- On Image Vanish
- Load Image
- Save Image
- Attach Browser
- Close Tab
- Go Back
- Go Forward
- Go Home
- Inject JS Script
- Navigate To
- Open Browser
- Refresh Browser
- Set Web Attribute
- Attach Window
- Close Window
- Get Active Window
- Hide Window
- Maximize Window
- Minimize Window
- Move Window
- Restore Window
- Show Window
- Export UI Tree
- Invoke ActiveX Method
- Inject .NET Code
- Click Trigger
- Key Press Trigger
- Click Image Trigger
- System Trigger
- Hotkey Trigger
- Mouse Trigger
- Get Event Info
- Monitor Events
- Get Source Element
- Replay User Event
- Block User Input
- Use Foreground
- Element Attribute Change Trigger
- Element State Change Trigger
- Callout
- Copy Selected Text
- Get From Clipboard
- Set To Clipboard
- Close Application
- Open Application
- Start Process
- Get Password
- Tooltip
- Click Picture on Screen
- Click Toolbar Button
- Read Statusbar
- Select Dates in Calendar
- Select Menu Item
- Expand Tree
- Call Transaction
- SAP Logon
- SAP Login
- Table Cell Scope
- SAP Session Attributes Change Trigger
- Expand ALV Tree
- Expand ALV Hierarchical Table
- Use Application/Browser
- Check App State
- Check/Uncheck
- Click
- Extract Table Data
- Get Text
- Get URL
- Go to URL
- Highlight
- Hover
- Keyboard Shortcuts
- Navigate Browser
- Select Item
- Take Screenshot
- Type Into
- Get Attribute
- Get Browser Data
- Set Browser Data
- Mouse Scroll
- Inject Js Script
- Drag and Drop
- For Each UI Element
- Application Event Trigger
- Click Event Trigger
- Keypress Event Trigger
- Set Text
- Check Element
- 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
- 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
- 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
- Draw Pattern
APIs
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.
Overloads
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.
UI Automation APIs
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. |
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. |
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. |
Using UI Automation APIs
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
IScreenDescriptor
overload: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 theTargetAppModel
overload: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
IElementDescriptor
overload: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 theTargetAnchorableModel
overloads: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