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
- 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
UI Automation Activities
Last updated Oct 28, 2024
Block User Input
UiPath.System.Activities.BlockUserInput
A container which disables the mouse and keyboard when activities inside it run. Can be configured to block either mouse, keyboard, or both, and permits you to designate a hotkey combination to re-enable them.
Note: Certain user input devices such as touchpads, trackpads or touchscreens may not be completely blocked by this activity. Due
to the wide variety of device models and drivers as well as the complex commands their gestures can produce, some multi-finger
gestures or touchscreen specific interactions are sent to the operating system as software events. Since in UI Automation
scenarios, Robots use software events to simulate human interaction, they cannot be blocked.
Note: Using Block User Input with Parallel activities (such as Parallel For Each) is not supported.
Note: When running an automation process that uses the Block User Input activity as a job from Orchestrator, and the Executor does not have administrator privileges on the machine you run the process on, any application that has a higher privilege
than the Executor and is in focus cannot be blocked by the activity. As a workaround, offering administrator privileges to the Executor enables the Block User Input activity to work as expected.
Note: Using Debug inside a Block User Input scope enables the effects of the scope. To disable the block, you can use the hotkey combination specified in the Unblock Options section of the properties. Once turned off, the state of all elements can be inspected as usual in a Debug context. Please
note that execution can only be continued without the effect of the scope and workflow functionality might be broken.
Common
-
ContinueOnError - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (True, False). The default value is False. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to True, the execution of the project continues regardless of any error.
Note: If this activity is included in Try Catch and the value of the ContinueOnError property is True, no error is caught when the project is executed. - DisplayName - The display name of the activity.
Input
- Block - A drop-down list which specifies whether you want to disable only mouse, only keyboard, or both.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Unblock options
Note: Once the designated hotkey combination for reactivating user input is pressed, and user input is restored, it cannot be blocked
again during the same runtime. The hotkey combination is implemented as a safeguard against blocking yourself from stopping
the workflow while developing it.
- Key - The key you want to use to reactivate the mouse and keyboard.
- KeyModifiers - The modifiers you want to use alongside the key selected in the Key property to reactivate the mouse and keyboard. The following options are available: Alt, Ctrl, Shift, and Win.
-
SpecialKey - Indicates if you are using a special key in the keyboard shortcut. A list of all available special keys is provided in the Key drop-down list present in the body of the activity.
Note: If other keys are pressed simultaneously with the designated key combination, the user input is restored anyway. This is designed as a safeguard against cases when the automation process hangs while continuously sending keys. - Timeout (milliseconds) - The amount of time the activity waits before throwing an error, expressed in milliseconds. This field supports only integers
and
Int32variables.
