用户界面自动化活动

上次更新日期 2024年12月4日

用户界面自动化 API

API 允许您访问“管理包”菜单中提供的服务并与之交互。您可以在设计编码自动化时使用这些 API。访问编码自动化，了解编码自动化以及如何使用 API 设计这些自动化。

注意：使用“转到定义”(F12) 允许您访问特定服务的 UiPath API 定义。我们建议在实施编码自动化时仅依赖直接公开的 API。未直接与服务一起公开的其他 API 如有更改，恕不另行通知。

重载

API 通常具有重载，这意味着它们为同一方法的多个版本提供不同的参数选项。重载允许您根据特定要求自定义 API 的行为。例如，用户界面自动化 API 可能具有接受超时参数的重载，以指定在结束执行之前等待用户界面元素出现的最长时间。

通过使用具有各自重载的 API，您可以轻松实现所需的自动化逻辑和行为。

用户界面自动化 API

本节包括 UiPath.UIAutomationNext.API.Contracts 服务中的 API。

API	描述
附加	聚焦于已打开的桌面应用程序或网页浏览器页面，以在用户界面自动化中使用。
选中	选中或清除复选框或单选按钮。
单击	单击指定的用户界面元素，例如按钮或链接。您可以根据用例进一步配置单击操作。
ClosePopup	关闭应用程序顶部的所有弹出窗口。
拖放	执行从源用户界面元素到目标用户界面元素的拖放操作。
提取数据	将数据提取为数据表。
获取属性	检索指定用户界面元素的指定属性的值。
获取子项	检索指定目标的子项。
获取运行时目标	检索指定目标的运行时目标。
GetText	从用户界面元素中提取并复制文本。
获取 URL	从当前网页检索 URL。
GoToUrl	在指定的网页浏览器中导航到指定的 URL。
高亮显示	将指定的用户界面元素放入框中，从而使其高亮显示。
悬停	从当前网页检索 URL。
IsEnabled	检查是否启用了用户界面元素。
键盘快捷方式	向用户界面元素发送一个或多个键盘快捷方式。
鼠标滚动	通过向指定的用户界面元素发送鼠标滚动事件来启用应用程序中的滚动。
打开	打开要在用户界面自动化中使用的桌面应用程序或网页浏览器页面。
选择项目	从下拉组合框或列表框中选择一个项目。
SetRuntimeBrowser	设置当前活动的运行时浏览器。
SetValue	在任何输入字段上设置值：输入框、下拉列表、复选框、单选按钮。
截取屏幕截图	截取指定用户界面元素或应用程序的屏幕截图，并将其保存为文件。
键入	在指定的用户界面元素中输入文本，例如文本框。您还可以向用户界面元素发送特殊键（如 Tab 或 Enter）。
等待状态	通过验证元素是出现在用户界面还是从用户界面消失，检查应用程序或网页浏览器的状态。

使用用户界面自动化 API

您可以将用户界面自动化 API 与用户界面元素结合使用。自动化用户界面应用程序的流程包括打开或聚焦所需的应用程序，然后自动化其用户界面元素。执行以下步骤，使用用户界面自动化 API 自动化应用程序：

使用附加 API 和打开 API 时，调用用户界面自动化服务。这些 API 可单独使用，以打开或聚焦应用程序或网页浏览器。
1. 在使用从对象存储库中捕获的用户界面元素作为描述符时，请使用带有 IScreenDescriptor 重载的 Open API 或 Attach API：
  uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
2. 对于原生选取器，请使用用户界面探测器复制应用程序的 <app/> 标签，并利用具有 TargetAppModel 重载的 Open API：
  var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"))
直接对用户界面元素调用用户界面自动化 API。
1. 在使用从对象存储库中捕获的用户界面元素作为描述符时，请将其余 API 与 IElementDescriptor 重载一起使用：
```
var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello")var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello")
```
2. 对于原生选取器，使用用户界面探测器复制元素的 <webctrl/> 标签，并通过 TargetAnchorableModel 重载使用其余 API：
```
var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"));
applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"));
applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")
```