activities
latest
false
UI Automation activities
- 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
- Element Scope
- 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
- Save Image
- Select Item
- Set Browser Data
- Set Clipboard
- Set CV Server
- Set Runtime Browser
- Set Focus
- Set Project Setting
- Set Text
- Take Screenshot
- Type Into
- Unblock User Input
- 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
- Terminal coded automation APIs
Highlight in the UI Automation coded automation API: visually highlights a specified UI element by surrounding it in a box.
Visually highlights a specified UI element by surrounding it in a box.
Definition
Namespace: UiPath.UIAutomationNext.API.Models
Assembly: UiPath.UIAutomationNext.API.Models (in UiPath.UIAutomationNext.API.Models dll)
Overloads
| Overload | Description |
|---|---|
Highlight(String, HighlightOptions) | Highlights a specified UI element, identified as a string from the Object Repository, along with other customizations. |
Highlight(TargetAnchorableModel, HighlightOptions) | Highlights a specific UI element, identified as a TargetAnchorableModel, along with other customizations. |
Highlight(String, KnownColor, Double) | Highlights a specific UI element, identified as a string from the Object Repository, while specifying the color of the highlight and for how long it should be highlighted. |
Highlight(String, HighlightOptions)
Highlights a specified UI element, identified as a string from the Object Repository, along with other customizations.
Highlight(
string target,
HighlightOptions highlightOptions)
Highlight(
string target,
HighlightOptions highlightOptions)
target String: The UI element that you want to highlight, identified as a string from the
Object Repository.
highlightOptions: Additional options to customize the highlight action:
* `HighlightTime Double` - The number of seconds for which to highlight the target element. The default value is 2 seconds.
* `Color
KnownColor` - Choose the color of the box that surrounds the highlighted element. The default value is Gold.
* `HighlightTime Double` - The number of seconds for which to highlight the target element. The default value is 2 seconds.
* `Color
KnownColor` - Choose the color of the box that surrounds the highlighted element. The default value is Gold.
Highlight(TargetAnchorableModel, HighlightOptions)
Highlights a specific UI element, identified as a TargetAnchorableModel, along with other customizations.
Highlight(
TargetAnchorableModel target,
HighlightOptions highlightOptions)
Highlight(
TargetAnchorableModel target,
HighlightOptions highlightOptions)
target TargetAnchorableModel: The UI element that you want to highlight, identified as a TargetAnchorableModel object.
highlightOptions: Additional options to customize the highlight action:
* `HighlightTime Double` - The number of seconds for which to highlight the target element. The default value is 2 seconds.
* `Color KnownColor` - Choose the color of the box that surrounds the highlighted element. The default value is
Gold.
* `HighlightTime Double` - The number of seconds for which to highlight the target element. The default value is 2 seconds.
* `Color KnownColor` - Choose the color of the box that surrounds the highlighted element. The default value is
Gold.
Highlight(String, KnownColor, Double)
Highlights a specific UI element, identified as a string from the Object Repository, while specifying the color of the highlight and for how long it should be highlighted.
Highlight(
string target,
[KnownColor color],
[double duration])
Highlight(
string target,
[KnownColor color],
[double duration])
target String: The UI element that you want to highlight, identified as a string from the
Object Repository.
color KnownColor: Choose the color of the box that surrounds the highlighted element. The default value is Gold.
duration Double: The number of seconds for which to highlight the target element. The default value is 2 seconds.