等待控件
动词：waitControl
等待用户定义的选择器指定的控件显示。
在 Windows 上下文中，控件是允许用户与应用程序进行交互的元素。 控件可以是按钮、数据输入字段、菜单和各种其他元素。
语法
waitControl [--forcerefresh(Boolean)] --selector(ControlSelectors) --id(String) --name(String) --innertext(String) --tagname(String) --xpath(String) --classname(String) --elementvalue(String) --controltype(Nullable<ControlTypes>) --index(Numeric) --control(Control) [--usetable(Boolean)] [--searchbycolumn(Boolean)] --searchcolumn(String) --searchvalue(String) --returncolumn(String) --row(Numeric) [--timeout(TimeSpan)] (Boolean)=value
输入
| 脚本 | 设计器 | 必需的 | AcceptedTypes | Description |
|---|---|---|---|---|
| --forcerefresh | 更新屏幕高速缓存 | 可选 | BOOLEAN | 启用后，将在执行命令之前执行屏幕的新读取，以识别新元素并更新屏幕高速缓存。要正确运行命令，必须进行此识别，以防屏幕上有任何更改。 |
| --selector | 选择器 | 必需的 | ControlSelectors | 用于识别用户界面控件的选择器的类型。 提供了以下选项：除了在脚本中插入带有自动填充这些参数的命令外，还可以使用 IBM RPA Studio的记录器来映射控件并获取 "选择器" 参数的必要信息。 该记录器在平台上的上方工具栏中可用。 |
| -- 标识 | 标识 | 仅当“选择器”为“标识”或“标识和名称”时 | 文本 | 应等待的控件的标识。 |
| -- 名称 | 名称 | 仅当“选择器”为“名称”、“名称和值”、“标识和名称”或“类型和名称”时 | 文本 | 应等待的控件的名称。 |
| --innertext | 文本 | 仅当“选择器”为“内部文本和标记”时 | 文本 | 应等待的控件的内部文本。 |
| --tagname | 元素类型 | 仅当“选择器”为“内部文本和标记”时 | 文本 | 应等待的元素的类型。 |
| --xpath | XPath | 仅当“选择器”为“XPath”时 | 文本 | 将转至应等待的控件的 XPath。 |
| --classname | 类 | 仅当“选择器”为“类和值”或“类名”时 | 文本 | 应等待的控件的类。 |
| --elementvalue | 元素值 | 仅当“选择器”为“类和值”或“名称和值”时 | 文本 | 应等待的元素的值。 |
| --controltype | 类型 | 仅当“选择器”为“类型和索引”或“类型和名称”时 | ControlTypes | 应等待的控件的类型。 |
| -- 索引 | 索引 | 仅当“选择器”为“类型和索引”时 | 成员 | 应等待的控件的索引。 |
| --control | 控件 | 仅当“选择器”为“实例”时 | 控件 | 控件实例。使用命令搜索控件获取此变量。 |
| --usetable | 表中的元素 | 可选 | BOOLEAN | 启用后，将可以按列或行在表中查找元素。 |
| --searchbycolumn | 按列搜索 | 可选 | BOOLEAN | 启用后，将按列而不是行在表中搜索元素。 |
| --searchcolumn | 列 | 仅当“表中的元素”为 True 时 | 文本 | 列名或值 |
| --searchvalue | 值 | 仅当“按列搜索”为 True 时 | 文本 | 用于在表中查找元素的值。 |
| --returncolumn | 返回列 | 仅当“按列搜索”为 True 时 | 文本 | 包含控件的列。 |
| --row | 行 | 仅当“按列搜索”为 False 时 | 成员 | 将查找元素的表行。 |
| --timeout | 超时 | 可选 | 时间范围、数字、文本 | 命令执行超时。如果在超时参数中未定义任何值，那么执行将使用命令设置超时定义的上下文时间。 如果脚本未使用此命令，那么缺省时间为 5 秒。 |
输出
| 脚本 | 设计器 | AcceptedTypes | Description |
|---|---|---|---|
| 值 | 成功 | BOOLEAN | 如果成功执行此命令，那么返回“True”；否则，返回“False”。 |
示例
使用启动并附加窗口命令打开“记事本”窗口，使用等待控件命令等待应用程序文本框显示，同时在“success”变量中，返回执行命令的成功或失败结果。 在带有 日志消息的 IBM RPA Studio 控制台中演示了 "success" 中包含的值。
defVar --name success --type Boolean
launchWindow --executablepath "notepad.exe"
waitControl --selector "XPath" --xpath "/root/document[1]" success=value
logMessage --message "Success: ${success}" --type "Info"
// Opens a Notepad window and waits for the text box.
备注
可以使用 IBM RPA Studio的记录器来获取以下信息:
包含等待的控件的窗口必须与执行上下文关联。