コントロールの取得
動詞: getControl
コントロールから情報を取得します。
構文
getControl --selector(ControlSelectors) [--forcerefresh(Boolean)] --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)] (Control)=control (Rectangle)=bounds (Numeric)=handle (String)=class
入力
| スクリプト | Designer | 必須 | 許容タイプ | 説明 |
|---|---|---|---|---|
| --selector | セレクター | 必須 | ControlSelectors | ユーザー・インターフェース・コントロールを指定するために使用するセレクターのタイプ。 次のオプションがあります。IBM RPA Studio のレコーダーを使用してコントロールをマップし、「セレクター」のパラメーターに必要な情報を取得できます。また、自動入力機能を使用してコマンドを追加できます。レコーダーは、Studio のメイン・メニューで利用できます。 「レコーダー」は、プラットフォーム上部のツールバーにあります。 |
| --forcerefresh | 画面キャッシュの更新 | オプション | Boolean | 有効にすると、コマンドを実行する前に新たに画面が読み取られるので、新規エレメントを検出して画面キャッシュを更新できます。画面が変更された場合には、このようにして検出しないとコマンドが正常に機能しません。 |
| -- ID | ID | 「セレクター」が「ID」、「ID と名前」の場合のみ | テキスト | 情報を取得するコントロールの ID。 |
| -- 名前 | 名前 | 「セレクター」が「名前」、「名前と値」、「ID と名前」、「タイプと名前」の場合のみ | テキスト | 情報を取得するコントロールの名前。 |
| --innertext | テキスト | 「セレクター」が「内部テキストおよびタグ」の場合のみ | テキスト | コントロールの内部テキスト。 |
| --tagname | エレメント・タイプ | 「セレクター」が「内部テキストおよびタグ」の場合のみ | テキスト | コントロールの情報を取得するエレメントのタイプ。 |
| -- XPath | XPath | 「セレクター」が「XPath」の場合のみ | テキスト | 情報を取得するコントロールへの Xpath。 |
| --classname | クラス | 「セレクター」が「クラスと値」、「クラス名」の場合のみ | テキスト | 情報を取得するコントロールのクラス。 |
| --elementvalue | エレメント値 | 「セレクター」が「クラスと値」、「名前と値」の場合のみ | テキスト | コントロールの情報を取得するエレメントの値。 |
| --controltype | タイプ | 「セレクター」が「タイプと索引」、「タイプと名前」の場合のみ | ControlTypes | 情報を取得するコントロールのタイプ。 |
| -- 索引 | 索引 | 「セレクター」が「タイプと索引」の場合のみ | 数値 | 情報を取得するコントロールの索引。 |
| -- 制御 | CONTROL | 「セレクター」が「インスタンス」の場合のみ | Control | コントロールのインスタンス。この変数は、コントロールの検索のコマンドを使用して取得します。 |
| --usetable | 表内のエレメント | オプション | Boolean | 有効にすると、列または行を使用して、表内のエレメントを検索できます。 |
| --searchbycolumn | 列で検索 | オプション | Boolean | 行ではなく列を使用して、表内のエレメントを検索します。 |
| --searchcolumn | 縦棒グラフ | 「表内のエレメント」が「True」の場合のみ | テキスト | エレメントを取得する列の名前または値。 |
| --searchvalue | 値 | 「列で検索」が「True」の場合のみ | テキスト | 表内のエレメントを検索するために使用する値。 |
| --returncolumn | 戻り列 | 「列で検索」が「True」の場合のみ | テキスト | コントロールが含まれている列。 |
| -- 行 | 行 | 「列で検索」が「False」の場合のみ | 数値 | エレメントを検索する表の行。 |
| -- タイムアウト | タイムアウト | オプション | 時間幅、数値、テキスト | コマンドを実行する最大制限時間。「タイムアウト」パラメーターに値が定義されていない場合、実行では、「タイムアウトの設定」コマンドによって定義されたコンテキスト・タイムアウトが使用されます。 このコマンドをスクリプトで使用していない場合、デフォルトのタイムアウトは 5 秒です。 |
出力
| スクリプト | Designer | 許容タイプ | 説明 |
|---|---|---|---|
| control | CONTROL | Control | コントロールのインスタンスを返します。 |
| bounds | 制限 | 四角形 | コントロールの制限を返します。 |
| handle | Handle | 数値 | コントロールのハンドルを返します。ハンドルは、ウィンドウの ID です。 |
| クラス | クラス | テキスト | コントロールのクラスを返します。 |
例
ウィンドウの起動およびアタッチのコマンドで、「メモ帳」ウィンドウを開いて実行コンテキストに関連付けます。 コマンド Get Control は、このウィンドウから制御情報を取得し、最後に IBM Robotic Process Automation Studio コンソールで取得した情報を 「ログ・メッセージ」 に記録します。
defVar --name limits --type Rectangle
defVar --name windowId --type Numeric
defVar --name class --type String
defVar --name window --type Window
launchWindow --executablepath "notepad.exe" --timeout 00:00:10 window=value
getControl --selector "XPath" --xpath "/root" class=class windowId=handle limits=bounds
logMessage --message "Limits: ${limits}\r\nClass: ${class}\r\nHandle: ${windowId}" --type "Info"
// Opens and associates a Notepad window with the execution context, obtains its control information and registers it in the IBM Robotic Process Automation Studio console.
注釈
IBM Robotic Process Automation Studio のレコーダーを使用して、以下の情報を取得できます。