获取选项

获取用户界面控件的选项。

命令可用性: 本地 IBM RPA SaaS 和 IBM RPA

Description

获取用户界面控件的选项。 在 Windows 上下文中，控件是允许用户与应用程序进行交互的元素。 控件可以是按钮、数据输入字段、菜单和各种其他元素。 期望的结果是具有所需值的数据表或字符串字典。

脚本语法

getOptions [--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)] (DataTable)=properties (StringDictionary<String>)=valueText (StringDictionary<String>)=indexText

输入参数

下表显示了此命令中提供的输入参数的列表。 在表中，您可以看到在 IBM RPA Studio的脚本方式及其 Designer 方式等效标签中工作时的参数名称。

设计器方式下的标签 脚本方式名称 必需的 接受的变量类型 Description
更新屏幕高速缓存 forcerefresh 可选 布尔值 启用后，会先更新屏幕高速缓存，然后再运行命令以识别新元素。 要正确运行命令，必须进行此识别，以防屏幕上有任何更改。
选择器 selector 必需的 ControlSelectors 用于标识用户界面控件的选择器的类型。

请参阅 selector 参数选项。

注: 您可以使用 IBM RPA Studio的记录器来映射控件，以获取 Selector 参数的必要信息。 您还可以使用它将命令添加到脚本中。 请参阅 记录器 文档以获取更多信息。
标识 id 仅当选择器为 Id 或 IdAndName 时 文本 应从中获取选项的控件的标识。
名称 name 仅当选择器为 Name、NameAndValue、IdAndName 和 TypeAndName 时 文本 应从中获取选项的控件的名称。
文本 innerText 仅当选择器为 InnerTextAndTag 时 文本 控件的内部文本。
ElementType tagname 仅当选择器为 InnerTextAndTag 时 文本 将从中获取选项的元素的类型或标记。

注: 一个元素可以是一个按钮或一个文本框。
XPath xpath 仅当选择器为 XPath 时 文本 将转至应从中获取选项的控件的 XPath 路径。
类 classname 仅当选择器为 ClassAndValue 或 ClassName 时 文本 应从中获取选项的控件的类。
ElementValue elementvalue 仅当选择器为 ClassAndValue 或 NameAndValue 时 文本 应从中获取选项的元素的当前值。
类型 controltype 仅当选择器为 TypeAndIndex 或 TypeAndName 时 ControlTypes 可供选择器查找的控件的类型。

请参阅 controltype 参数选项。
索引 index 仅当选择器为 TypeAndIndex 时 数字 应从中获取选项的控件的索引。
控件 control 仅当选择器为实例时 控件 控件实例。 您可以使用搜索控件命令获取此变量。
表中的元素 usetable 可选 布尔值 启用后，将按列或行在表中搜索元素。
按列搜索 searchbycolumn 可选 布尔值 启用后，将按列而不是行访存元素。
列 searchcolumn 仅当表中的元素为 True 时 文本 列的名称或值。
值 searchvalue 仅当“按列搜索”为 True 时 文本 用于在表中查找元素的值。
返回列 returncolumn 仅当“按列搜索”为 True 时 文本 包含控件的列。
行 row 仅当“按列搜索”为 False 时 数字 将查找元素的表行。
Timeout timeout 可选 时间范围、数字和文本 命令执行超时。

注: 缺省超时为 5 秒。 您可以使用 设置超时 (setTimeout) 命令来更改缺省值。

selector 参数选项

下表显示了可用于 Selector 输入参数的选项。

设计器方式标签 脚本方式名称 Description
类和值 ClassAndValue 用于按“类”和“值”标识用户界面的选择器。
类名 ClassName 用于按类名标识用户界面的选择器。
标识 Id 用于按标识识别用户界面的选择器。
标识和名称 IdAndName 用于按标识和名称来标识用户界面的选择器。
内部文本和控件类型 InnerTextAndTag 用于按内部文本和控件类型标识用户界面的选择器。
实例 Instance 用于按实例标识用户界面的选择器。
名称 Name 用于按名称标识用户界面的选择器。
名称和值 NameAndValue 用于按名称和值标识用户界面的选择器。
类型和索引 TypeAndIndex 用于按类型和索引标识用户界面的选择器。
类型和名称 TypeAndName 用于按类型和名称标识用户界面的选择器。
XPath XPath 用于按 XPath 标识用户界面的选择器。

controltype 参数选项

下表显示了可用于 controltype 输入参数的选项。

设计器方式标签 脚本方式名称 Description
按钮 Button 控件类型为“按钮”。
复选框 CheckBox 控件类型为“复选框”。
子窗口 ChildWindow 控件类型为“子窗口”。
组合框 ComboBox 控件类型是组合框。
常规 Generic 控件类型为“常规”。
Image Image 控件类型为“图像”。
标签 Label 控件类型为“标签”。
列表框 ListBox 控件类型为“列表框”。
菜单栏 MenuBar 控件类型为“菜单栏”。
菜单项 MenuItem 控件类型为“菜单项”。
进度条 ProgressBar 控件类型为“进度条”。
单选按钮 RadioButton 控件类型为“单选按钮”。
滚动条 ScrollBar 控件类型为“滚动条”。
滑块 Slider 控件类型为“滑块”。
微调器 Spinner 控件类型为“微调器”。
状态栏 Status bar 控件类型为“状态栏”。
选项卡页面 TabPage 控件类型为“选项卡页面”。
选项卡面板 TabPanel 控件类型为“选项卡面板”。
表 Table 控件类型为“表”。
文本框 TextBox 控件类型为“文本框”。
切换按钮 ToggleButton 控件类型为“切换”按钮。
树形视图 TreeView 控件类型为“树形视图”。
TreeTable TreeTable 控件类型为“树表”。
窗口 Window 控件类型为“窗口”。

输出参数

设计器方式标签 脚本方式名称 接受的变量类型 Description
属性 properties 数据表 针对每个选项，返回包含索引、值和文本的数据表。
值-文本字典 valueText String Dictionary<Text> 返回字符串字典，输入每个选项的键和值。
索引-文本字典 indexText String Dictionary<Text> 返回带有与每个选项的文本关联的索引的字符串字典。

示例

根据 启动并附加窗口 命令打开的可执行文件，该命令将从组合框 "国家或地区" 中获取选项，并通过分配给它的标识进行识别，并由 IBM RPA Studio的记录器进行映射。

defVar --name dataTableResult --type DataTable
defVar --name indexTextResult --type "StringDictionary<TValue>" --innertype String
// Opens an app for testing.
launchWindow --executablepath "CSharpTestApp.exe"
// Get the options of the entered control.
getOptions --selector "IdAndName" --id cmbCountry --name "Country :" dataTableResult=properties indexTextResult=indexText
logMessage --message "Data Table: ${dataTableResult}\r\nIndex and Value: ${indexTextResult}" --type "Info"
// Returns data table with index, key and value for each option and a dictionary with indexes associated with each option text.