Check
UiPath.CV.Activities.CvCheckWithDescriptor
UI AutomationSelects, clears or toggles check boxes. Only CheckBox type elements are supported.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| Action | In | InArgument<UiPath.Core.Activities.CheckType> |
|||
| CursorMotionType | In | InArgument<UiPath.UIAutomationNext.Enums.CursorMotionType> |
CV Click
UiPath.CV.Activities.CvClickWithDescriptor
UI AutomationClicks a specified UI element which is targeted using UiPath Computer Vision.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| InRegion | In | InArgument<Drawing.Rectangle> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| KeyModifiers | In | InArgument<UiPath.Core.Activities.KeyModifiers> |
|||
| CursorMotionType | In | InArgument<UiPath.UIAutomationNext.Enums.CursorMotionType> |
|||
| ClickType | In | InArgument<UiPath.Core.ClickType> |
|||
| MouseButton | In | InArgument<UiPath.Core.MouseButton> |
|||
| ContinueOnError | In | InArgument<Boolean> |
CV Element Exists
UiPath.CV.Activities.CvElementExistsWithDescriptor
UI AutomationSearches for a specified UI element on the screen in the foreground using UiPath Computer Vision, and returns a Boolean variable that states whether it was found or not.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| Result | Out | OutArgument<Boolean> |
|||
| InRegion | In | InArgument<Drawing.Rectangle> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
CV Extract Table
UiPath.CV.Activities.CvExtractDataTableWithDescriptor
UI AutomationExtracts a table visible on the screen.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
Mono.Cecil.CustomAttributeArgument |
||
| NumberOfScrolls | In | InArgument<Int32> |
2 |
||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| Result | Out | OutArgument<Data.DataTable> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| AddHeaders | In | InArgument<Boolean> |
True |
||
| RefreshBefore | In | InArgument<Boolean> |
True |
||
| IgnoreEmptyRows | In | InArgument<Boolean> |
False |
||
| Scroll | In | InArgument<Boolean> |
False |
||
| ScrollOffset | In | InArgument<Drawing.Point> |
CV Get Text
UiPath.CV.Activities.CvGetTextWithDescriptor
UI AutomationExtracts text from a specified position based on an anchor.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| Scroll | In | InArgument<Boolean> |
|||
| ScrollOffset | In | InArgument<Drawing.Point> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| InRegion | In | InArgument<Drawing.Rectangle> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| RefreshBefore | In | InArgument<Boolean> |
True |
||
| Result | Out | OutArgument<String> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| MethodType | property | UiPath.CV.GetTextMethodType |
CV Highlight
UiPath.CV.Activities.CvHighlightWithDescriptor
UI AutomationVisually highlights a specified UI element identified using UiPath Computer Vision.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| InRegion | In | InArgument<Drawing.Rectangle> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| HighlightTime | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Color | property | Drawing.Color |
CV Hover
UiPath.CV.Activities.CvHoverWithDescriptor
UI AutomationHovers over a specified UI element which is targeted by using UiPath Computer Vision.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| HoverTime | In | InArgument<Double> |
|||
| TimeoutMS | In | InArgument<Int32> |
|||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| InRegion | In | InArgument<Drawing.Rectangle> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| CursorMotionType | In | InArgument<UiPath.UIAutomationNext.Enums.CursorMotionType> |
CV Screen Scope
UiPath.CV.Activities.CVScope
UI AutomationA container that enables Computer Vision on a window or element. Also acts as a refresh mechanism.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ContinueOnError | In | InArgument<Boolean> |
|||
| CvMethod | In | InArgument<UiPath.CV.CVMethods> |
|||
| Server | In | InArgument<String> |
|||
| ApiKey | In | InArgument<String> |
|||
| UseLocalServer | In | InArgument<Boolean> |
|||
| ScrollOffset | In | InArgument<Drawing.Point> |
|||
| DelayBefore | In | InArgument<Int32> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| OCREngine | child | ActivityFunc<Drawing.Image, IEnumerable<KeyValuePair<Drawing.Rectangle, String>>> |
|
| Body | child | ActivityAction<Object> |
CV Dropdown Select
UiPath.CV.Activities.CvSelectItemWithDescriptor
UI AutomationSpecifies the item to be selected from a dropdown list.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| DelayBetweenKeys | In | InArgument<Int32> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| Text | In | InArgument<UiPath.CV.CvString> |
✓ | ||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| ClickBeforeTyping | In | InArgument<Boolean> |
|||
| EmptyField | In | InArgument<Boolean> |
|||
| Activate | In | InArgument<Boolean> |
|||
| ContinueOnError | In | InArgument<Boolean> |
CV Type Into
UiPath.CV.Activities.CvTypeIntoWithDescriptor
UI AutomationSends keystrokes to a UI element. Special keys are supported and can be selected from the drop-down list. The UI element is identified using UiPath Computer Vision.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| TimeoutMS | In | InArgument<Int32> |
|||
| DelayMS | In | InArgument<Int32> |
|||
| DelayBetweenKeys | In | InArgument<Int32> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| Text | In | InArgument<UiPath.CV.CvString> |
✓ | ||
| Descriptor | In | InArgument<UiPath.CV.CvDescriptor> |
|||
| ScrollDirection | In | InArgument<UiPath.CV.Scroll> |
|||
| NumberOfScrolls | In | InArgument<Int32> |
|||
| DelayScreenshotAfterScroll | In | InArgument<Int32> |
|||
| InRegion | In | InArgument<Drawing.Rectangle> |
|||
| OutRegion | Out | OutArgument<Drawing.Rectangle> |
|||
| ClickBeforeTyping | In | InArgument<Boolean> |
|||
| EmptyField | In | InArgument<Boolean> |
|||
| Activate | In | InArgument<Boolean> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Invoke ActiveX Method
UiPath.Core.Activities.InvokeActiveX
UI AutomationInvokes an Internet Explorer ActiveX object automation method.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| MethodName | In | InArgument<String> |
✓ | ||
| Result | Out | OutArgument<Object> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Arguments | property | Dictionary<String, Argument> |
|
| Target | property | UiPath.Core.Activities.Target |
Activate
UiPath.Core.Activities.Activate
UI AutomationEnables you to activate a specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DelayMS | In | InArgument<Int32> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Export UI Tree
UiPath.Core.Activities.ExportUiTree
UI AutomationExports all available UI elements
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Filter | In | InArgument<String> |
|||
| DestinationFile | In | InArgument<String> |
|||
| OperationTimeoutMS | In | InArgument<Nullable<Int32>> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
|
| UiFramework | property | UiPath.Core.Activities.UiTree.SelectorStrategy |
|
| Format | property | UiPath.Core.Activities.UiTree.ExportFormat |
|
| IncludeScreenshots | property | Boolean |
|
| Overwrite | property | Boolean |
|
| Priority | property | UiPath.Core.Activities.UiTree.Priority |
Set Clipping Region
UiPath.Core.Activities.SetClippingRegion
UI AutomationSets the clipping region of a UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Direction | In | InArgument<UiPath.Core.Direction> |
|||
| Region | In | InArgument<UiPath.Core.Region> |
|||
| Element | In | InArgument<UiPath.Core.UiElement> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Size | property | UiPath.Core.Region |
Set Focus
UiPath.Core.Activities.SetFocus
UI AutomationSets keyboard focus to a specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DelayMS | In | InArgument<Int32> |
|||
| DelayBefore | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Get Position
UiPath.Core.Activities.GetPosition
UI AutomationRetrieves the bounding rectangle of a specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Rectangle | Out | OutArgument<Drawing.Rectangle> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Select Multiple Items
UiPath.Core.Activities.SelectMultipleItems
UI AutomationSelects one or more options from a multiple options list box. After you indicate the element on the screen, use MultipleItems property to define the options that will be selected at runtime.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| MultipleItems | In | InArgument<String[]> |
✓ | ||
| AddToSelection | In | InArgument<Boolean> |
False |
||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayAfter | In | InArgument<Int32> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Set Web Attribute
UiPath.Core.Activities.SetWebAttribute
UI AutomationSets the value of a specified web attribute.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Attribute | In | InArgument<String> |
✓ | ||
| Value | In | InArgument<String> |
✓ | ||
| DelayBefore | In | InArgument<Int32> |
|||
| DelayAfter | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Wait Attribute
UiPath.Core.Activities.WaitAttribute
UI AutomationWaits for the value of a specified UI element attribute to be equal to a string.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Attribute | In | InArgument<String> |
✓ | ||
| AttributeValue | In | InArgument<Object> |
✓ | ||
| TimeoutMS | In | InArgument<Int32> |
|||
| Element | In | InArgument<UiPath.Core.UiElement> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Find Children
UiPath.Core.Activities.FindChildren
UI AutomationRetrieves a collection of children UI elements according to a specified scope and filter criteria.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Filter | In | InArgument<String> |
✓ | ||
| Scope | In | InArgument<UiPath.Core.FindScope> |
|||
| Children | Out | OutArgument<IEnumerable<UiPath.Core.UiElement>> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Find Relative Element
UiPath.Core.Activities.FindRelative
UI AutomationSearches for a UI element by using a position relative to a fixed element. This should be used when a reliable selector is not available.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| RelativeElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| CursorPosition | property | UiPath.Core.Activities.CursorPosition |
|
| Target | property | UiPath.Core.Activities.Target |
Get Ancestor
UiPath.Core.Activities.GetAncestor
UI AutomationRetrieves an ancestor for a specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Ancestor | Out | OutArgument<UiPath.Core.UiElement> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| UpLevels | property | Int32 |
|
| Target | property | UiPath.Core.Activities.Target |
Indicate On Screen
UiPath.Core.Activities.IndicateOnScreen
UI AutomationEnables the user to select an UI element or region on screen while running the workflow.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| SelectScreenRegion | In | InArgument<Boolean> |
|||
| HidePreview | In | InArgument<Boolean> |
|||
| SelectedUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Find Element
UiPath.Core.Activities.WaitUiElementAppear
UI AutomationWaits for the specified UI element to appear on the screen and returns it as a UiElement variable.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FoundElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| WaitVisible | In | InArgument<Boolean> |
|||
| WaitActive | In | InArgument<Boolean> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Find Image Matches
UiPath.Core.Activities.FindImageMatches
UI AutomationSearches for matches for a specific image in a target UI element and returns a collection of UI elements which have the clipping region set to the screen position of the matches.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Matches | Out | OutArgument<IEnumerable<UiPath.Core.UiElement>> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Image | property | UiPath.Core.Activities.ImageTarget |
|
| Target | property | UiPath.Core.Activities.Target |
Load Image
UiPath.Core.Activities.LoadImage
UI AutomationEnables you to load an image from the disk and save it to an Image variable.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FileName | In | InArgument<String> |
✓ | ||
| Image | Out | OutArgument<UiPath.Core.Image> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Save Image
UiPath.Core.Activities.SaveImage
UI AutomationEnables you to save an image to your disk.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FileName | In | InArgument<String> |
✓ | ||
| Image | In | InArgument<UiPath.Core.Image> |
✓ | ||
| ContinueOnError | In | InArgument<Boolean> |
Inject .NET Code
UiPath.Core.Activities.InjectDotNetCode
UI AutomationInjects .NET code into target process.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AssemblyPath | In | InArgument<String> |
✓ | ||
| TypeName | In | InArgument<String> |
✓ | ||
| MethodName | In | InArgument<String> |
✓ | ||
| PassUIControlAsFirstArgument | In | InArgument<Boolean> |
|||
| Result | Out | OutArgument<Object> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Arguments | property | Dictionary<String, Argument> |
|
| Target | property | UiPath.Core.Activities.Target |
Google Cloud Vision OCR
UiPath.Core.Activities.GoogleCloudOCR
UI Automation.OCR.EngineExtracts a string and its information from an indicated UI element using the Google Cloud Vision OCR engine. It can be used with other OCR activities (Click OCR Text, Hover OCR Text, Double Click OCR Text, Get OCR Text, Find OCR Text Position).
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ApiKey | In | InArgument<String> |
|||
| Region | In | InArgument<UiPath.Vision.Core.OCR.GoogleCloudRegion> |
|||
| Language | In | InArgument<String> |
|||
| Scale | In | InArgument<Double> |
|||
| Text | Out | OutArgument<String> |
|||
| Image | In | InArgument<Drawing.Image> |
✓ | ||
| Profile | In | InArgument<UiPath.Vision.OCR.OCRProfile> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| DetectionMode | property | UiPath.Vision.Core.OCR.GoogleCloudDetectionMode |
|
| ResizeToApiLimits | property | Boolean |
|
| ExtractWords | property | Boolean |
|
| FilterRegion | property | UiPath.Core.Region |
Tesseract OCR
UiPath.Core.Activities.GoogleOCR
UI Automation.OCR.EngineExtracts a string and its information from an indicated UI element using Tesseract OCR Engine. It can be used with other OCR activities (Click OCR Text, Hover OCR Text, Double Click OCR Text, Get OCR Text, Find OCR Text Position).
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AllowedCharacters | In | InArgument<String> |
|||
| DeniedCharacters | In | InArgument<String> |
|||
| Invert | In | InArgument<Boolean> |
|||
| Profile | In | InArgument<UiPath.Vision.OCR.OCRProfile> |
|||
| Language | In | InArgument<String> |
|||
| Scale | In | InArgument<Double> |
|||
| Text | Out | OutArgument<String> |
|||
| Image | In | InArgument<Drawing.Image> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ExtractWords | property | Boolean |
|
| FilterRegion | property | UiPath.Core.Region |
Microsoft Azure Computer Vision OCR
UiPath.Core.Activities.MicrosoftAzureComputerVisionOCR
UI Automation.OCR.EngineExtracts a string and its information from an indicated UI element using the Microsoft Azure Computer Vision OCR engine. It can be used with other OCR activities (Click OCR Text, Hover OCR Text, Double Click OCR Text, Get OCR Text, Find OCR Text Position).
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ApiKey | In | InArgument<String> |
|||
| Endpoint | In | InArgument<String> |
|||
| Language | In | InArgument<String> |
|||
| Scale | In | InArgument<Double> |
|||
| Text | Out | OutArgument<String> |
|||
| Image | In | InArgument<Drawing.Image> |
✓ | ||
| Profile | In | InArgument<UiPath.Vision.OCR.OCRProfile> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| HandwritingRecognition | property | Boolean |
|
| ExtractWords | property | Boolean |
|
| FilterRegion | property | UiPath.Core.Region |
Get OCR Text
UiPath.Core.Activities.GetOCRText
UI AutomationExtracts a string and its information from an indicated UI element using the OCR screen scraping method. This activity can also be automatically generated when performing screen scraping, along with a container.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Text | Out | OutArgument |
|||
| WordsInfo | Out | OutArgument<IEnumerable<UiPath.Core.TextInfo>> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.Core.Activities.Target |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| OCREngine | child | ActivityFunc<Drawing.Image, IEnumerable<KeyValuePair<Drawing.Rectangle, String>>> |
Get Active Window
UiPath.Core.Activities.GetActiveWindow
UI AutomationRetrieves the current active Window and enables you to perform multiple actions within it.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ApplicationWindow | Out | OutArgument<UiPath.Core.Window> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<Object> |
Hide Window
UiPath.Core.Activities.HideWindow
UI AutomationHides the indicated window. This makes the window completely invisible.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Window | In | InArgument<UiPath.Core.Window> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Maximize Window
UiPath.Core.Activities.MaximizeWindow
UI AutomationMaximizes the indicated window.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Window | In | InArgument<UiPath.Core.Window> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Minimize Window
UiPath.Core.Activities.MinimizeWindow
UI AutomationMinimizes the indicated window.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Window | In | InArgument<UiPath.Core.Window> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Move Window
UiPath.Core.Activities.MoveWindow
UI AutomationChanges the position and dimensions of the indicated window.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| X | In | InArgument<Int32> |
|||
| Y | In | InArgument<Int32> |
|||
| Width | In | InArgument<Int32> |
|||
| Height | In | InArgument<Int32> |
|||
| Window | In | InArgument<UiPath.Core.Window> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Restore Window
UiPath.Core.Activities.RestoreWindow
UI AutomationRestores a specified window to its original size and position.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Window | In | InArgument<UiPath.Core.Window> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Show Window
UiPath.Core.Activities.ShowWindow
UI AutomationDisplays and activates the specified window.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Window | In | InArgument<UiPath.Core.Window> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Extract Form Data
UiPath.Semantic.Activities.NExtractFormDataGeneric
UI Automation.ApplicationUses AI to seamlessly extract form data.
No members extracted.
Fill Form
UiPath.Semantic.Activities.NFillForm
UI Automation.ApplicationUses AI to seamlessly populate the designated form with information extracted from the provided data source.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DataSource | In | InArgument<Object> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| EnableValidation | property | Boolean |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Update UI Element
UiPath.Semantic.Activities.NSetValue
UI Automation.ApplicationUses AI to seamlessly update an UI element’s state/value.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Value | In | InArgument<String> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| EnableValidation | property | Boolean |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
ScreenPlay
UiPath.Semantic.Activities.NUITask
UI Automation.ApplicationPerforms a given UI task, using AI, on the attached application.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Task | In | InArgument<String> |
|||
| AgentType | In | InArgument<UiPath.UIAutomationNext.Enums.NUITaskAgentType> |
|||
| Result | Out | OutArgument<String> |
|||
| CustomConfiguration | In | InArgument<String> |
|||
| ClipboardMode | In | InArgument<UiPath.UIAutomationNext.Enums.NTypeByClipboardMode> |
|||
| TraceAttachMode | In | InArgument<UiPath.UIAutomationNext.Enums.NTraceAttachMode> |
|||
| MaxIterations | In | InArgument<Int32> |
|||
| IsDOMEnabled | In | InArgument<Boolean> |
|||
| IsVariableSecurityDisabled | In | InArgument<Boolean> |
|||
| ExecutionTrace | Out | OutArgument<String> |
|||
| TraceFiles | Out | OutArgument<UiPath.UIAutomationNext.Models.NUITaskTraceFiles> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Prompt | property | IEnumerable<InArgument<String>> |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Use Application/Browser
UiPath.UIAutomationNext.Activities.NApplicationCard
UI Automation.ApplicationOpens a desktop application or web browser page to use in your automation.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ContinueOnError | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| OpenMode | In | InArgument<UiPath.UIAutomationNext.Enums.NAppOpenMode> |
|||
| CloseMode | In | InArgument<UiPath.UIAutomationNext.Enums.NAppCloseMode> |
|||
| UserDataFolderMode | In | InArgument<UiPath.UIAutomationNext.Enums.BrowserUserDataFolderMode> |
|||
| UserDataFolderPath | In | InArgument<String> |
|||
| IsIncognito | In | InArgument<Boolean> |
|||
| WebDriverMode | In | InArgument<UiPath.UIAutomationNext.Enums.NWebDriverMode> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TargetApp | property | UiPath.UIAutomationNext.TargetApp |
|
| InteractionMode | property | UiPath.UIAutomationNext.Enums.NInteractionMode |
|
| AttachMode | property | UiPath.UIAutomationNext.Enums.NAppAttachMode |
|
| WindowResize | property | UiPath.UIAutomationNext.Enums.NWindowResize |
|
| DialogHandling | property | UiPath.UIAutomationNext.DialogHandling |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| OCREngine | child | ActivityFunc<Drawing.Image, IEnumerable<KeyValuePair<Drawing.Rectangle, String>>> |
|
| Body | child | ActivityAction<Object> |
Browser Dialog Scope
UiPath.UIAutomationNext.Activities.NBrowserDialogScope
UI Automation.BrowserCaptures and handles browser dialogs such as alert, confirm and prompt.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DialogMessage | Out | OutArgument<String> |
|||
| DialogResponse | In | InArgument<UiPath.UIAutomationNext.Enums.NBrowserDialogResponse> |
|||
| PromptDialogResponseText | In | InArgument<String> |
|||
| WaitForDialogToAppearTimeout | In | InArgument<Double> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| DialogScopeType | property | UiPath.UIAutomationNext.Enums.NBrowserDialogScopeType |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | Activity |
Browser File Picker Scope
UiPath.UIAutomationNext.Activities.NBrowserFilePickerScope
UI Automation.BrowserCaptures and handles a browser file picker dialog.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| SingleFilePath | In | InArgument<String> |
|||
| MultiFilePaths | In | InArgument<List<String>> |
|||
| WaitForDialogToAppearTimeout | In | InArgument<Double> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Mode | property | UiPath.UIAutomationNext.Enums.NBrowserFilePickerScopeMode |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | Activity |
Check/Uncheck
UiPath.UIAutomationNext.Activities.NCheck
UI Automation.ApplicationUsed to check, uncheck, or toggle a checkbox.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Action | In | InArgument<UiPath.UIAutomationNext.Enums.NCheckType> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Check Element
UiPath.UIAutomationNext.Activities.NCheckElement
UI Automation.ApplicationChecks if an element is enabled or disabled.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Result | Out | OutArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Check App State
UiPath.UIAutomationNext.Activities.NCheckState
UI Automation.ApplicationEnsures the automated app is in a specific state, by verifying if a UI element exists or not. A set of user-defined actions are executed based on the detected state.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Exists | Out | OutArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| CheckWindowActive | In | InArgument<Boolean> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Mode | property | UiPath.UIAutomationNext.Enums.NCheckStateMode |
|
| CheckVisibility | property | Boolean |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| IfExists | child | Activity |
|
| IfNotExists | child | Activity |
Click
UiPath.UIAutomationNext.Activities.NClick
UI Automation.ApplicationClicks a specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| KeyModifiers | In | InArgument<UiPath.UIAutomationNext.Enums.NKeyModifiers> |
|||
| ClickType | In | InArgument<UiPath.UIAutomationNext.Enums.NClickType> |
|||
| MouseButton | In | InArgument<UiPath.UIAutomationNext.Enums.NMouseButton> |
|||
| CursorMotionType | In | InArgument<UiPath.UIAutomationNext.Enums.CursorMotionType> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| ActivateBefore | In | InArgument<Boolean> |
|||
| UnblockInput | In | InArgument<Boolean> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| VerifyOptions | property | UiPath.UIAutomationNext.Activities.VerifyExecutionOptions |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Click Event Trigger
UiPath.UIAutomationNext.Activities.NClickTrigger
UI Automation.ApplicationSetup a click event trigger on the indicated UI Element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Button | In | InArgument<UiPath.UIAutomationNext.Enums.NMouseButton> |
|||
| KeyModifiers | In | InArgument<UiPath.UIAutomationNext.Enums.NKeyModifiers> |
|||
| BlockEvent | In | InArgument<Boolean> |
|||
| IncludeChildren | In | InArgument<Boolean> |
|||
| Mode | In | InArgument<UiPath.UIAutomationNext.Triggers.NClickTriggerMode> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SchedulingMode | property | UiPath.Platform.Triggers.TriggerActionSchedulingMode |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Close Popup
UiPath.UIAutomationNext.Activities.NClosePopup
UI Automation.ApplicationDismisses all popups that are on top of the application and block a target, using the configured close buttons.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| PopupException | In | InArgument<Exception> |
|||
| PreferredButtons | In | InArgument<String[]> |
|||
| PopupHandled | Out | OutArgument<UiPath.UIAutomationNext.Enums.NPopupHandleState> |
|||
| PopupAppearTimeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| EnableAI | property | Boolean |
Drag and Drop
UiPath.UIAutomationNext.Activities.NDragAndDrop
UI Automation.ApplicationExecutes a drag and drop operation from the source UI element to the destination UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| KeyModifiers | In | InArgument<UiPath.UIAutomationNext.Enums.NKeyModifiers> |
|||
| MouseButton | In | InArgument<UiPath.UIAutomationNext.Enums.NMouseButton> |
|||
| DelayBetweenActions | In | InArgument<Double> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| DestinationTarget | property | UiPath.UIAutomationNext.TargetAnchorable |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Extract Table Data
UiPath.UIAutomationNext.Activities.NExtractData
UI Automation.ApplicationExtracts tabular data from a specified web page or application.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DataTable | InOut | InOutArgument<Data.DataTable> |
|||
| ExtractMetadata | In | InArgument<String> |
✓ | ||
| MaximumResults | In | InArgument<Int32> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| DelayBetweenPages | In | InArgument<Double> |
|||
| ExtractDataSettings | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| LimitExtractionTo | property | UiPath.UIAutomationNext.Models.ExtractData.LimitType |
|
| NextLink | property | UiPath.UIAutomationNext.TargetAnchorable |
|
| AppendResults | property | Boolean |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Extract Table Data
UiPath.UIAutomationNext.Activities.NExtractDataGeneric
UI Automation.ApplicationExtracts tabular data from a specified web page or application.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| InputDataTable | In | InArgument<Data.DataTable> |
|||
| ExtractedData | Out | OutArgument<T> |
|||
| ExtractMetadata | In | InArgument<String> |
✓ | ||
| MaximumResults | In | InArgument<Int32> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| DelayBetweenPages | In | InArgument<Double> |
|||
| ExtractDataSettings | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| LimitExtractionTo | property | UiPath.UIAutomationNext.Models.ExtractData.LimitType |
|
| NextLink | property | UiPath.UIAutomationNext.TargetAnchorable |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
For Each UI Element
UiPath.UIAutomationNext.Activities.NForEachUiElement
UI Automation.ApplicationIterates over a structured set of UiElements.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ContinueOnError | In | InArgument<Boolean> |
|||
| MaximumResults | In | InArgument<Int32> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| DelayBetweenPages | In | InArgument<Double> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| NextLink | property | UiPath.UIAutomationNext.TargetAnchorable |
|
| LimitExtractionTo | property | UiPath.UIAutomationNext.Models.ExtractData.LimitType |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<Int32> |
Get Attribute
UiPath.UIAutomationNext.Activities.NGetAttribute
UI Automation.ApplicationRetrieves the value of a specified attribute of the indicated UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Result | Out | OutArgument |
|||
| Attribute | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Get Attribute
UiPath.UIAutomationNext.Activities.NGetAttributeGeneric
UI Automation.ApplicationRetrieves the value of a specified attribute of the indicated UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Result | Out | OutArgument<T> |
|||
| Attribute | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Get Browser Data
UiPath.UIAutomationNext.Activities.NGetBrowserData
UI Automation.BrowserExports the session data from the specified browser instance.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Browser | In | InArgument<UiPath.Core.Browser> |
|||
| BrowserType | In | InArgument<UiPath.UIAutomationNext.Enums.NBrowserType> |
|||
| SourceUserDataFolder | In | InArgument<String> |
|||
| UserProfile | In | InArgument<String> |
|||
| SessionData | Out | OutArgument<String> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Get Clipboard
UiPath.UIAutomationNext.Activities.NGetClipboard
UI Automation.ApplicationGets the system's Clipboard data.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Result | Out | OutArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Get Text
UiPath.UIAutomationNext.Activities.NGetText
UI Automation.ApplicationExtracts the text from a specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Text | Out | OutArgument |
|||
| TextString | Out | OutArgument<String> |
|||
| WordsInfo | Out | OutArgument<IEnumerable<UiPath.UIAutomationNext.Activities.Models.NWordInfo>> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ScrapingMethod | property | UiPath.UIAutomationNext.Enums.NScrapingMethod |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Get URL
UiPath.UIAutomationNext.Activities.NGetUrl
UI Automation.BrowserReturns the URL from the current browser.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| WaitForReady | In | InArgument<UiPath.UIAutomationNext.Enums.NWaitForReady> |
|||
| CurrentUrl | Out | OutArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Go To URL
UiPath.UIAutomationNext.Activities.NGoToUrl
UI Automation.BrowserNavigates to the specified URL in the indicated web browser.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Url | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Highlight
UiPath.UIAutomationNext.Activities.NHighlight
UI Automation.ApplicationVisually highlights a specified UI element by surrounding it in a box.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| HighlightTime | In | InArgument<Double> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Color | property | Drawing.Color |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Hover
UiPath.UIAutomationNext.Activities.NHover
UI Automation.ApplicationHovers the mouse over a specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| HoverTime | In | InArgument<Double> |
|||
| CursorMotionType | In | InArgument<UiPath.UIAutomationNext.Enums.CursorMotionType> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| VerifyOptions | property | UiPath.UIAutomationNext.Activities.VerifyExecutionOptions |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Inject Js Script
UiPath.UIAutomationNext.Activities.NInjectJsScript
UI Automation.BrowserExecutes JavaScript code in the context of the web page corresponding to a UiElement.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| InputParameter | In | InArgument<String> |
|||
| ScriptCode | In | InArgument<String> |
|||
| ScriptOutput | Out | OutArgument |
|||
| ExecutionWorld | In | InArgument<UiPath.UIAutomationNext.Enums.NExecutionWorld> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Keyboard Shortcuts
UiPath.UIAutomationNext.Activities.NKeyboardShortcuts
UI Automation.ApplicationSends one or more keyboard shortcuts to a UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ActivateBefore | In | InArgument<Boolean> |
|||
| DelayBetweenShortcuts | In | InArgument<Double> |
|||
| DelayBetweenKeys | In | InArgument<Double> |
|||
| ClickBeforeMode | In | InArgument<UiPath.UIAutomationNext.Enums.NClickMode> |
|||
| ShortcutsArgument | In | InArgument<String> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Shortcuts | property | String |
|
| VerifyOptions | property | UiPath.UIAutomationNext.Activities.VerifyExecutionOptions |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Keypress Event Trigger
UiPath.UIAutomationNext.Activities.NKeyboardTrigger
UI Automation.ApplicationSetup a key pressed event trigger on the indicated UI Element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Key | In | InArgument<String> |
|||
| KeyModifiers | In | InArgument<UiPath.UIAutomationNext.Enums.NKeyModifiers> |
|||
| BlockEvent | In | InArgument<Boolean> |
|||
| IncludeChildren | In | InArgument<Boolean> |
|||
| Mode | In | InArgument<UiPath.UIAutomationNext.Triggers.NKeyTriggerMode> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SchedulingMode | property | UiPath.Platform.Triggers.TriggerActionSchedulingMode |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Mouse Scroll
UiPath.UIAutomationNext.Activities.NMouseScroll
UI Automation.ApplicationSends mouse scroll events to the specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Direction | In | InArgument<UiPath.UIAutomationNext.Enums.NScrollDirection> |
|||
| MovementUnits | In | InArgument<Int32> |
|||
| CursorMotionType | In | InArgument<UiPath.UIAutomationNext.Enums.CursorMotionType> |
|||
| KeyModifiers | In | InArgument<UiPath.UIAutomationNext.Enums.NKeyModifiers> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SearchedElement | property | UiPath.UIAutomationNext.Activities.SearchedElement |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Application Event Trigger
UiPath.UIAutomationNext.Activities.NNativeEventTrigger
UI Automation.ApplicationSetup a trigger on a given event on the indicated UI Element.
No members extracted.
Call Transaction
UiPath.UIAutomationNext.Activities.NSAPCallTransaction
UI Automation.SAPExecutes a transaction code or program in the current SAP GUI window.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Transaction | In | InArgument<String> |
|||
| Prefix | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Click Picture on Screen
UiPath.UIAutomationNext.Activities.NSAPClickPictureOnScreen
UI Automation.SAPClicks the picture displayed on a SAP GUI screen.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| KeyModifiers | In | InArgument<UiPath.UIAutomationNext.Enums.NKeyModifiers> |
|||
| ClickType | In | InArgument<UiPath.UIAutomationNext.Enums.NClickType> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| ActivateBefore | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Click Toolbar Button
UiPath.UIAutomationNext.Activities.NSAPClickToolbarButton
UI Automation.SAPClicks a button from the system or application SAP toolbars. After indicating the SAP Toolbar on the screen, the list with all available buttons is displayed in the activity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Item | In | InArgument<String> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Expand ALV Hierarchical Table
UiPath.UIAutomationNext.Activities.NSAPExpandALVHierarchicalTable
UI Automation.SAPUse the activity to identify any cell inside SAP ALV Hierarchical Table. After the identification of the cell all typical UI activities can be performed, such as Click, Double Click, Get Text and others.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| FocusedColumn | In | InArgument<String> |
|||
| ColumnNameLevel0 | In | InArgument<String> |
|||
| ColumnNameLevel1 | In | InArgument<String> |
|||
| ColumnValueLevel0 | In | InArgument<String> |
|||
| ColumnValueLevel1 | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Expand ALV Tree
UiPath.UIAutomationNext.Activities.NSAPExpandALVTree
UI Automation.SAPExpand parent ALV tree to the selected node. After indicating the SAP node element from the SAP GUI window, the selected node path will be displayed in the activity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Path | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Expand Tree
UiPath.UIAutomationNext.Activities.NSAPExpandTree
UI Automation.SAPExpand parent tree to an active node or an active item. After indicating the SAP Tree element from the SAP GUI window, the Tree list with all available nodes and items is displayed in the activity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Item | In | InArgument<String> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
SAP Login
UiPath.UIAutomationNext.Activities.NSAPLogin
UI Automation.SAPUse the activity to log into an SAP system.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Username | In | InArgument<String> |
|||
| SecurePassword | In | InArgument<Security.SecureString> |
|||
| Password | In | InArgument<String> |
|||
| Client | In | InArgument<String> |
|||
| Language | In | InArgument<String> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Option | property | UiPath.UIAutomationNext.Enums.NMultiLogonOption |
SAP Logon
UiPath.UIAutomationNext.Activities.NSAPLogon
UI Automation.SAPUse the activity to directly log on to an SAP system. Provide the exact SAP connection name from the SAP Logon or the SAP Logon Pad window used to log on to your SAP system.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Retries | In | InArgument<Int32> |
|||
| DelayBetweenRetries | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| OpenMode | In | InArgument<UiPath.UIAutomationNext.Enums.NAppOpenMode> |
|||
| CloseMode | In | InArgument<UiPath.UIAutomationNext.Enums.NAppCloseMode> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NHealingAgentBehavior> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| TargetApp | property | UiPath.UIAutomationNext.TargetApp |
|
| InteractionMode | property | UiPath.UIAutomationNext.Enums.NInteractionMode |
|
| AttachMode | property | UiPath.UIAutomationNext.Enums.NAppAttachMode |
|
| WindowResize | property | UiPath.UIAutomationNext.Enums.NWindowResize |
|
| DialogHandling | property | UiPath.UIAutomationNext.DialogHandling |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| OCREngine | child | ActivityFunc<Drawing.Image, IEnumerable<KeyValuePair<Drawing.Rectangle, String>>> |
|
| Body | child | ActivityAction<Object> |
Read Status Bar
UiPath.UIAutomationNext.Activities.NSAPReadStatusbar
UI Automation.SAPReads the message displayed in the Status Bar on the bottom of the SAP GUI window.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| MessageType | Out | OutArgument<String> |
|||
| MessageText | Out | OutArgument<String> |
|||
| MessageId | Out | OutArgument<String> |
|||
| MessageNumber | Out | OutArgument<String> |
|||
| MessageData | Out | OutArgument<String[]> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Select Dates In Calendar
UiPath.UIAutomationNext.Activities.NSAPSelectDatesInCalendar
UI Automation.SAPSelect Dates in Calendar. The activity can be used to select single dates or periods of time.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| SelectType | In | InArgument<UiPath.UIAutomationNext.Enums.NDateSelectionType> |
|||
| Date | In | InArgument<DateTime> |
|||
| StartDate | In | InArgument<DateTime> |
|||
| EndDate | In | InArgument<DateTime> |
|||
| Year | In | InArgument<Int32> |
|||
| Week | In | InArgument<Int32> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Select Menu Item
UiPath.UIAutomationNext.Activities.NSAPSelectMenuItem
UI Automation.SAPSelect a Menu Item from the main SAP GUI window. After indicating the window, the list with all available Menu Items is displayed in the activity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Item | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Table Cell Scope
UiPath.UIAutomationNext.Activities.NSAPTableCellScope
UI Automation.SAPA container that enables you to attach to an existing Table UI element and perform multiple actions within it.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ColumnName | In | InArgument<String> |
|||
| RowIndex | In | InArgument<UInt32> |
|||
| RowSelector | In | InArgument<String> |
|||
| RowType | In | InArgument<UiPath.UIAutomationNext.Enums.NSAPTableCellScopeRowType> |
|||
| TableRow | Out | OutArgument<UInt32> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<Object> |
Select Item
UiPath.UIAutomationNext.Activities.NSelectItem
UI Automation.ApplicationSelects an item from a drop-down list.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Item | In | InArgument<String> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Set Browser Data
UiPath.UIAutomationNext.Activities.NSetBrowserData
UI Automation.BrowserImports the session data into a specified browser instance.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Browser | In | InArgument<UiPath.Core.Browser> |
|||
| SessionData | In | InArgument<String> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Set Clipboard
UiPath.UIAutomationNext.Activities.NSetClipboard
UI Automation.ApplicationSets the system's Clipboard data to the given text.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Text | In | InArgument<String> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Set Focus
UiPath.UIAutomationNext.Activities.NSetFocus
UI Automation.ApplicationSets keyboard focus to the specified UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Set Runtime Browser
UiPath.UIAutomationNext.Activities.NSetRuntimeBrowser
UI Automation.BrowserSets the currently active runtime browser.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| BrowserType | In | InArgument<UiPath.UIAutomationNext.Enums.NBrowserType> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Set Text
UiPath.UIAutomationNext.Activities.NSetText
UI Automation.ApplicationEnters text in a specified UI element, for example a text box.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Text | In | InArgument<String> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| CacheTargetElement | property | Boolean |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Take Screenshot
UiPath.UIAutomationNext.Activities.NTakeScreenshot
UI Automation.ApplicationTakes a screenshot of an application or UI element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DelayBeforeScreenshot | In | InArgument<Double> |
|||
| FileName | In | InArgument<String> |
|||
| FileNameMode | In | InArgument<UiPath.UIAutomationNext.Enums.NFileNameMode> |
|||
| SavedTo | Out | OutArgument |
|||
| OutImage | Out | OutArgument<UiPath.Core.Image> |
|||
| OutFile | Out | OutArgument<UiPath.Platform.ResourceHandling.ILocalResource> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Type Into
UiPath.UIAutomationNext.Activities.NTypeInto
UI Automation.ApplicationEnters text in a specified UI element, for example a text box.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Text | In | InArgument<String> |
|||
| SecureText | In | InArgument<Security.SecureString> |
|||
| DelayBetweenKeys | In | InArgument<Double> |
|||
| ActivateBefore | In | InArgument<Boolean> |
|||
| ClickBeforeMode | In | InArgument<UiPath.UIAutomationNext.Enums.NClickMode> |
|||
| EmptyFieldMode | In | InArgument<UiPath.UIAutomationNext.Enums.NEmptyFieldMode> |
|||
| ClipboardMode | In | InArgument<UiPath.UIAutomationNext.Enums.NTypeByClipboardMode> |
|||
| DeselectAfter | In | InArgument<Boolean> |
|||
| AlterIfDisabled | In | InArgument<Boolean> |
|||
| InteractionMode | In | InArgument<UiPath.UIAutomationNext.Enums.NChildInteractionMode> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| VerifyOptions | property | UiPath.UIAutomationNext.Activities.VerifyExecutionTypeIntoOptions |
|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Block User Input
UiPath.UIAutomationNext.Activities.NBlockUserInput
UI Automation.ApplicationSuppress keyboard/mouse input until the set key combination is pressed, or timeout exceeded.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DelayBefore | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| Timeout | In | InArgument<Double> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| BlockType | In | InArgument<UiPath.UIAutomationNext.Enums.NBlockInputType> |
|||
| KeyModifiers | In | InArgument<UiPath.UIAutomationNext.Enums.NKeyModifiers> |
|||
| Keys | In | InArgument<String> |
|||
| DisableUnblock | In | InArgument<Boolean> |
|||
| Allow3rdPartyApps | In | InArgument<Boolean> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | Activity |
Find Elements
UiPath.UIAutomationNext.Activities.NFindElements
UI Automation.ApplicationGets the child elements of the specified UI element
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Timeout | In | InArgument<Double> |
|||
| Mode | In | InArgument<UiPath.UIAutomationNext.Enums.NFindMode> |
|||
| Children | Out | OutArgument<IEnumerable<UiPath.Core.UiElement>> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Element Scope
UiPath.UIAutomationNext.Activities.NElementScope
UI Automation.ApplicationA container that enables you to attach to an existing UI element and perform multiple actions within it.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DelayBefore | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| Timeout | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Child Activities / Variable Scope
| Name | Kind | Type | Description |
|---|---|---|---|
| Body | child | ActivityAction<Object> |
Unblock User Input
UiPath.UIAutomationNext.Activities.NUnblockUserInput
UI Automation.ApplicationUnblock keyboard/mouse input that has been previously blocked by a 'Block User Input' activity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |
Window Operation
UiPath.UIAutomationNext.Activities.NWindowOperation
UI Automation.ApplicationPerform various operations on the specified window element.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Operation | In | InArgument<UiPath.UIAutomationNext.Enums.NWindowOperationType> |
|||
| X | In | InArgument<Int32> |
|||
| Y | In | InArgument<Int32> |
|||
| Width | In | InArgument<Int32> |
|||
| Height | In | InArgument<Int32> |
|||
| Timeout | In | InArgument<Double> |
|||
| DelayAfter | In | InArgument<Double> |
|||
| DelayBefore | In | InArgument<Double> |
|||
| ContinueOnError | In | InArgument<Boolean> |
|||
| OutUiElement | Out | OutArgument<UiPath.Core.UiElement> |
|||
| HealingAgentBehavior | In | InArgument<UiPath.UIAutomationNext.Enums.NChildHealingAgentBehavior> |
|||
| InUiElement | In | InArgument<UiPath.Core.UiElement> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| Target | property | UiPath.UIAutomationNext.TargetAnchorable |