値の取得

ユーザー・インターフェース・コントロール内に含まれる値を取得します。

コマンドの可用性: IBM RPA SaaS および IBM RPA オンプレミス

スクリプト構文

IBM RPA の専有スクリプト言語の構文は、他のプログラミング言語と似ています。 スクリプト構文は、スクリプト・ファイル内のコマンドの構文を定義します。 この構文は、 IBM RPA Studioの 「スクリプト」 モードで操作できます。

getValue [--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)] (String)=value (Numeric)=index (StringDictionary<String>)=selectedvalues (StringKeyValuePair<String>)=firstvalue

依存関係

「値の取得」 (getValue) コマンドを使用する前に、「ウィンドウの起動およびアタッチ」コマンドまたは「ウィンドウの起動またはアタッチ」コマンドを使用して Windows スコープを開始します。

入力パラメーター

以下の表は、このコマンドで使用可能な入力パラメーターのリストを示しています。 この表では、 IBM RPA Studioのスクリプト・モードで作業しているときのパラメーター名と、それに相当する Designer モードのラベルを確認できます。

「デザイナー」モードのラベル 「スクリプト」モードの名前 必須 使用可能な変数タイプ Description
画面キャッシュの更新 forcerefresh Optional Boolean これを有効にすると、画面を読み取って新規エレメントを識別し、画面キャッシュを更新することができます。 コマンドを実行する前に、画面の読み取りが行われます。

画面に変更がある場合は、このパラメーターを有効にする必要があります。
セレクター selector Required ControlSelectors ユーザー・インターフェース・コントロールを識別するセレクターのタイプ。

IBM RPA Studioのレコーダーを使用して、コントロールをマップし、このパラメーターに必要な情報を取得できます。

セレクター・パラメーター・オプションを参照してください。
ID id Required when the Selector parameter is Id, IdAndName Text コントロールの固有 ID。

SAP GUI で、ID セレクターを使用して、GridView コントロールをマップします。 GridView ID セレクターの動作について詳しくは、SAP 自動化での GridView コントロールの処理を参照してください。
名前 name Required when the parameter is Name, NameAndValue, IdAndName, TypeAndName Text コントロール名。
Text innertext Required when the Selector parameter is InnerTextAndTag Text コントロールが表示する内部テキスト。
エレメント・タイプ tagname Required when the Selector parameter is InnerTextAndTag Text コントロールのタグ名。
XPath xpath Required when the Selector parameter is XPath Text コントロール・ツリーからターゲット・コントロールまでのパス。
クラス classname Required when the Selector parameter is ClassAndValue, ClassName Text コントロールをインスタンス化するクラスの名前。
エレメント値 elementvalue Required when the Selector parameter is ClassAndValue, NameAndValue Text コントロールによって保管された値。
タイプ controltype Required when the Selector parameter is TypeAndIndex, TypeAndName ControlTypes コントロールのタイプ。

controltype パラメーター・オプションを参照してください。
索引 index Required when the Selector parameter is TypeAndIndex Number コントロールの位置。 索引はゼロから始まり、これが同じタイプ内の最初のコントロールになります。
Control control Required when the Selector parameter is Instance Control コントロール・インスタンス。

「コントロールの検索」コマンドによって Control 変数タイプを取得します。
表内のエレメント usetable Optional Boolean 有効にすると、表内のエレメントを検索します。
列で検索 searchbycolumn Optional Boolean これを有効にすると、表の特定の列内のエレメントを検索できます。
列 searchcolumn Required when the Element in Table parameter is True Text エレメントが検索される列の名前または索引。
値 searchvalue Required when the Search by Column parameter is True Text 表内のエレメントを検索するために使用される値。
戻り列 returncolumn Required when the Search by Column parameter is True Text コントロールが含まれている列。
行 row Required when the Search by Column parameter is False Number エレメントを取得する行番号。

このパラメーターを消去するには、「列で検索」パラメーターを有効にします。
タイムアウト timeout Optional Time Span, Number, Text コントロールを検出するまでの最大待機時間。 ブランクの場合、デフォルトのタイムアウトは 5 秒です。

selector パラメーター・オプション

次の表は、selector 入力パラメーターで使用可能なオプションを示しています。 この表は、「スクリプト」モードで作業するときに使用可能なオプションと、「デザイナー」モードでそれに相当するラベルを示しています。

「デザイナー」モードのラベル 「スクリプト」モードの名前 Description
クラスと値 ClassAndValue これは、制御クラス名と値に相当します。
クラス名 ClassName これは、コントロールをインスタンス化するクラス名に相当します。
ID Id これは、コントロールの固有 ID に相当します。
ID と名前 IdAndName これは、固有 ID とコントロール名に相当します。
内部テキストおよびコントロール・タイプ InnerTextAndTag これは、コントロールの内部テキストとそのタイプ属性を突き合わせます。
インスタンス Instance これは、コントロール・インスタンスに相当します。
名前 Name これは、コントロール名に相当します。
名前と値 NameAndValue これは、コントロール名と値に相当します。
タイプとインデックス TypeAndIndex これは、コントロール・タイプと、同じタイプのコントロール内でのその位置の索引に相当します。
タイプと名前 TypeAndName これは、コントロール・タイプと名前に相当します。
ビジョン Vision これは、コントロールを識別するためにマップされたイメージに相当します。
XPath XPath これは、コントロール・ツリーからターゲット・コントロールまでのパスと突き合わせます。

IBM RPA Studio のレコーダーを使用してコントロールをマップし、以下のセレクターを取得できます。

  • クラス名
  • ID
  • 内部テキスト
  • リンク・テキスト
  • 名前
  • タグ名
  • XPath

controltype パラメーター・オプション

次の表は、controltype 入力パラメーターで使用可能なオプションを示しています。 この表は、「スクリプト」モードで作業するときに使用可能なオプションと、「デザイナー」モードでそれに相当するラベルを示しています。

「デザイナー」モードのラベル 「スクリプト」モードの名前 Description
ボタン Button これは、アプリケーションのボタン・コントロールに相当します。
チェック・ボックス CheckBox これは、アプリケーションのチェック・ボックス・コントロールに相当します。
子ウィンドウ ChildWindow これは、アプリケーションの子ウィンドウ・コントロールに相当します。
コンボ・ボックス ComboBox これは、アプリケーションのコンボ・ボックス・コントロールに相当します。
一般 Generic これは、アプリケーションの一般コントロールに相当します。
画像 Image これは、アプリケーションのイメージ・コントロールに相当します。
ラベル Label これは、アプリケーションのラベル・コントロールに相当します。
リスト・ボックス ListBox これは、アプリケーションのリスト・ボックス・コントロールに相当します。
メニュー・バー MenuBar これは、アプリケーションのメニュー・バー・コントロールに相当します。
メニュー項目 MenuItem これは、アプリケーションのメニュー項目コントロールに相当します。
進行状況表示バー ProgressBar これは、アプリケーションの進行状況表示バー・コントロールに相当します。
ラジオ・ボタン RadioButton これは、アプリケーションのラジオ・ボタン・コントロールに相当します。
スクロール・バー ScrollBar これは、アプリケーションのスクロール・バー・コントロールに相当します。
スライダー Slider これは、アプリケーションのスライダー・コントロールに相当します。
スピナー Spinner これは、アプリケーションのスピナー・コントロールに相当します。
ステータス・バー StatusBar これは、アプリケーションのステータス・バー・コントロールに相当します。
タブ・ページ TabPage これは、アプリケーションのタブ・ページ・コントロールに相当します。
タブ・パネル TabPanel これは、アプリケーションのタブ・パネル・コントロールに相当します。
表 Table これは、アプリケーションの表コントロールに相当します。
テキスト・ボックス TextBox これは、アプリケーションのテキスト・ボックス・コントロールに相当します。
トグル・ボタン ToggleButton これは、アプリケーションのトグル・ボタン・コントロールに相当します。
ツリー表示 TreeView これは、アプリケーションのツリー・ビュー・コントロールに相当します。
TreeTable TreeTable これは、アプリケーションの TreeTable コントロールに相当します。
ウィンドウ Window これは、アプリケーションのウィンドウ・コントロールに相当します。

出力パラメーター

「デザイナー」モードのラベル 「スクリプト」モードの名前 使用可能な変数タイプ Description
値 value Text UI コントロールに含まれる値を返します。
索引 index Number UI コントロール内の選択された項目の索引を、リスト内の項目として返します。
選択された値 selectedvalues String Dictionary<Text> ユーザー・インターフェース・コントロールに含まれる値の値キーを返します。
最初に選択された値 firstvalue String Key Value Pair<Text> UI コントロールで取得した値の最初の値を返します。

例

以下のコード例は、「メモ帳」アプリケーションから値を取得する方法を示しています。 Get Value (getValue) コマンドは、「File」という名前のユーザー・インターフェース・コントロールに含まれる値を取得します。 「メモ帳」アプリケーションが閉じた後、「メッセージのログ」 (logMessage) コマンドによって、取得した値がログに記録されます。

defVar --name controlValue --type String
defVar --name notepadWindow --type Window
// Launch the notepad application 
launchWindow --executablepath "notepad.exe" notepadWindow=value
// Gets the value contained in the UI control that has the name "File" in Notepad
getValue --selector "Name" --name File controlValue=value
closeWindow --window ${notepadWindow}
// Logs the value obtained by the control
logMessage --message "Obtained control value: ${controlValue}" --type "Info"