附加

重点关注已打开的桌面应用程序或网页浏览器页面，以在用户界面自动化中使用。

使用此 API 时，您需要根据以下格式调用用户界面自动化服务： uiAutomation.<APIMethod>() 。 例如uiAutomation.Open() 。

定义

命名空间：UiPath.UIAutomationNext.API.Contracts

程序集：UiPath.UIAutomationNext.API.Contracts（在 UiPath.UIAutomationNext.API.Contracts dll 中）

重载

重载	描述
Attach(String, TargetAppOptions, String, String)	专注于要在用户界面自动化中使用的特定桌面应用程序或网页，由对象存储库中的屏幕名称标识。
Attach(TargetAppModel, TargetAppOptions)	专注于要在用户界面自动化中使用的特定桌面应用程序或网页，由 TargetAppModel 对象标识。
Attach(String, String, String, NAppAttachMode, NWindowResize, NInteractionMode)	专注于要在用户界面自动化中使用的特定桌面应用程序或网页，由对象存储库中的屏幕名称以及应用程序或网页的其他自定义项标识。

Attach(String, TargetAppOptions, String, String)

专注于要在用户界面自动化中使用的特定桌面应用程序或网页，由对象存储库中的屏幕名称标识。

Attach(
    string screenName,
    TargetAppOptions targetAppOptions,
    [string appName],
    [string appVersion])

screeName 字符串

要聚焦的屏幕的名称，为在对象存储库中记录的字符串。

targetAppOptions TargetAppOptions

用于附加到应用程序或网页的其他选项和设置：

• Timeout Double - 指定在引发错误之前等待执行活动的秒数。 默认值为 30 秒。 在远程桌面环境中指定窗口时，“超时”默认设置为 60 秒。
• InteractionMode NInteractionMode:
  • HardwareEvents - 使用硬件驱动程序执行 Actions。 这是最慢的 API，不能在后台工作，但可兼容所有桌面应用程序。
  • Simulate - 使用辅助功能 API 模拟 Actions 。 建议在浏览器自动化、Java 应用程序或 SAP 中使用。 比硬件事件更可靠。 在单个 Actions中发送所有文本。 即使目标应用程序不在焦点中，也适用。 请测试您的目标应用程序用户界面元素是否支持此功能。
  • DebuggerApi - 使用调试器 API 执行操作。仅适用于 Chromium 元素。一次性发送所有文本。即使目标应用程序不在焦点中，也适用。有关更多详细信息，请查看此页面。
  • WindowMessages - 通过 Win32 消息发送鼠标和键盘输入。 推荐用于桌面应用程序。 通常比硬件事件更可靠。 在单个 Actions中发送所有文本。 即使目标应用程序不在焦点中，也适用。 请测试您的目标应用程序用户界面元素是否支持此功能。
  • Background - 在后台运行操作。 在可能的情况下尝试使用模拟或 Chromium API，同时复杂的 API（图像、原生文本）将照常在前台运行。 强烈建议将此 API 与验证执行功能一起使用。
• OpenMode NAppOpenMode - 选择何时打开应用程序：
  • Never （从不打开应用程序）
  • IfNotOpen （仅在应用程序关闭时打开，这是默认选择，仅在提供 FilePath 或 URL 时有效）
  • Always （即使已打开应用程序的另一个实例，也要打开该实例，仅在提供 FilePath 或 URL 时有效）
• WindowResize NWindowResize - 选择窗口的大小：
  • None
  • Maximize
  • Restore
  • Minimize
• UserDataFolderMode BrowserUserDataFolderMode - 要设置的 UserDataFolderMode 。 它用于通过特定的用户数据文件夹启动浏览器。
  • Automatic - 画中画模式使用与默认模式不同的文件夹，如果未设置 UserDataFolderPath ，则自动生成画中画。
  • DefaultFolder - 使用默认浏览器文件夹，无论它是在主会话还是 PIP 会话中运行。
  • CustomFolder - 使用 UserDataFolderPath 中指定的文件夹；如果未设置 UserDataFolderPath ，则使用自动生成的路径。
• UserDataFolderPath String - 浏览器使用的用户数据文件夹。 如果未设置，则默认为 %LocalAppData%\UiPath\PIP Browser Profiles\BrowserType 。
• IsIncognito Boolean - 如果要以隐身模式打开浏览器，请输入 True 。 默认情况下，它设置为 False。
• WebDriverMode NWebDriverMode - 指示打开新浏览器会话时如何使用 WebDriver。 提供以下选项：
  • Disabled - 禁用 WebDriver。
  • WithGUI - 显示浏览器的 GUI。
  • Headless - 浏览器以静默方式启动，没有 GUI。

appName 字符串

要附加到的应用程序的名称。 此参数适用于桌面应用程序。

appVersion 字符串

要附加到的应用程序版本。 此参数适用于桌面应用程序。

Attach(TargetAppModel, TargetAppOptions)

专注于要在用户界面自动化中使用的特定桌面应用程序或网页，由 TargetAppModel 对象标识。

Attach(
    TargetAppModel targetApp,
    [TargetAppOptions targetAppOptions]))

targetApp TargetAppModel

要附加到的目标应用程序或网页。 它是类型为 TargetAppModel 的对象，可提供有关应用程序的信息：

• Selector String - 此为 XML 片段，用于存储用户界面元素的属性。
• FilePath String - 如果应用程序不是网页浏览器，请指定要打开的可执行文件的完整路径。
• Arguments String - 如果应用程序不是网页浏览器，则可以指定要在启动时传递给目标应用程序的参数。
• Url String - 如果应用程序是网页浏览器，则指定要打开的网页的 URL。
• Title String - 应用程序或浏览器的标题。

targetAppOptions TargetAppOptions

用于附加到应用程序或网页的其他选项和设置：

• Timeout Double - 指定在引发错误之前等待执行活动的秒数。 默认值为 30 秒。 在远程桌面环境中指定窗口时，“超时”默认设置为 60 秒。
• InteractionMode NInteractionMode:
  • HardwareEvents - 使用硬件驱动程序执行 Actions。 这是最慢的 API，不能在后台工作，但可兼容所有桌面应用程序。
  • Simulate - 使用辅助功能 API 模拟 Actions 。 建议在浏览器自动化、Java 应用程序或 SAP 中使用。 比硬件事件更可靠。 在单个 Actions中发送所有文本。 即使目标应用程序不在焦点中，也适用。 请测试您的目标应用程序用户界面元素是否支持此功能。
  • DebuggerApi - 使用调试器 API 执行操作。仅适用于 Chromium 元素。一次性发送所有文本。即使目标应用程序不在焦点中，也适用。有关更多详细信息，请查看此页面。
  • WindowMessages - 通过 Win32 消息发送鼠标和键盘输入。 推荐用于桌面应用程序。 通常比硬件事件更可靠。 在单个 Actions中发送所有文本。 即使目标应用程序不在焦点中，也适用。 请测试您的目标应用程序用户界面元素是否支持此功能。
  • Background - 在后台运行操作。 在可能的情况下尝试使用模拟或 Chromium API，同时复杂的 API（图像、原生文本）将照常在前台运行。 强烈建议将此 API 与验证执行功能一起使用。
• OpenMode NAppOpenMode - 选择何时打开应用程序：
  • Never （从不打开应用程序）
  • IfNotOpen （仅在应用程序关闭时打开，这是默认选择，仅在提供 FilePath 或 URL 时有效）
  • Always （即使已打开应用程序的另一个实例，也要打开该实例，仅在提供 FilePath 或 URL 时有效）
• WindowResize NWindowResize - 选择窗口的大小：
  • None
  • Maximize
  • Restore
  • Minimize
• UserDataFolderMode BrowserUserDataFolderMode - 要设置的 UserDataFolderMode 。 它用于通过特定的用户数据文件夹启动浏览器。
  • Automatic - 画中画模式使用与默认模式不同的文件夹，如果未设置 UserDataFolderPath ，则自动生成画中画。
  • DefaultFolder - 使用默认浏览器文件夹，无论它是在主会话还是 PIP 会话中运行。
  • CustomFolder - 使用 UserDataFolderPath 中指定的文件夹；如果未设置 UserDataFolderPath ，则使用自动生成的路径。
• UserDataFolderPath String - 浏览器使用的用户数据文件夹。 如果未设置，则默认为 %LocalAppData%\UiPath\PIP Browser Profiles\BrowserType 。
• IsIncognito Boolean - 如果要以隐身模式打开浏览器，请输入 True 。 默认情况下，它设置为 False。
• WebDriverMode NWebDriverMode - 指示打开新浏览器会话时如何使用 WebDriver。 提供以下选项：
  • Disabled - 禁用 WebDriver。
  • WithGUI - 显示浏览器的 GUI。
  • Headless - 浏览器以静默方式启动，没有 GUI。

Attach(String, String, String, NAppAttachMode, NWindowResize, NInteractionMode)

专注于要在用户界面自动化中使用的特定桌面应用程序或网页，由对象存储库中的屏幕名称以及应用程序或网页的其他自定义项标识。

Attach(string screenName,
    [string appName],
    [string appVersion],
    [NAppAttachMode appAttachMode],
    [NWindowResize windowResize],
    [NInteractionMode interactionMode]))

screeName 字符串

要聚焦的屏幕的名称，为在对象存储库中记录的字符串。

appName 字符串

要附加到的应用程序的名称。 此参数适用于桌面应用程序。

appVersion 字符串

要附加到的应用程序版本。 此参数适用于桌面应用程序。

appAttachMode NAppAttachMode

• ByProcessName - 进一步的 API 将在所有窗口中使用与指定应用程序相同的流程名称进行搜索。
• ByInstance - 其他 API 将在指定的应用程序实例中搜索，包括所有父窗口和子窗口（警示、弹出窗口等）。 排除应用程序的其他实例。
• SingleWindow - 其他 API 将仅在指定的窗口中搜索。

windowResize NWindowResize

选择窗口大小:

• None
• Maximize
• Restore
• Minimize

interactionMode NInteractionMode

选择机器人与目标应用程序交互时应使用的 API:

• HardwareEvents - 使用硬件驱动程序执行 Actions。 这是最慢的 API，不能在后台工作，但可兼容所有桌面应用程序。
• Simulate - 使用辅助功能 API 模拟 Actions 。 建议在浏览器自动化、Java 应用程序或 SAP 中使用。 比硬件事件更可靠。 在单个 Actions中发送所有文本。 即使目标应用程序不在焦点中，也适用。 请测试您的目标应用程序用户界面元素是否支持此功能。
• DebuggerApi - 使用调试器 API 执行操作。仅适用于 Chromium 元素。一次性发送所有文本。即使目标应用程序不在焦点中，也适用。有关更多详细信息，请查看此页面。
• WindowMessages - 通过 Win32 消息发送鼠标和键盘输入。 推荐用于桌面应用程序。 通常比硬件事件更可靠。 在单个 Actions中发送所有文本。 即使目标应用程序不在焦点中，也适用。 请测试您的目标应用程序用户界面元素是否支持此功能。
• Background - 在后台运行操作。 在可能的情况下尝试使用模拟或 Chromium API，同时复杂的 API（图像、原生文本）将照常在前台运行。 强烈建议将此 API 与验证执行功能一起使用。