SAP 要素レベルのメソッドの説明

SAP コネクタが提供するさまざまな要素レベルのメソッドを使用して、SAP 画面の UI 要素 (ボタンやチェックボックスなど) のアクションを自動化できます。

一般的なメソッド

次のメソッドは、SAP 画面上のすべての要素に適用されます。

注:

SAP 画面に表示される、このトピックには記載されていないその他の要素は、一般的なメソッドのみをサポートしています。

Highlight

SAP 画面で要素をハイライト表示します。

IsCreated

要素が SAP 画面に存在する場合は true を返し、要素が存在しない場合は false を返します。

MouseClick

SAP 画面上の要素に対してマウスクリックアクションを実行します。

表 : 1. MouseClick メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
clickType	マウスクリックのタイプ (左または右) を選択するオプション。	データ入力	列挙	左	いいえ

SendKeys

Enter や Ctrl などのキーボードストロークを SAP 画面上の要素に送信します。

表 : 2. SendKeys メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
keys	要素に送信するキーボードストローク。	データ入力	文字列	NA	はい
clearExistingValue	キーの値を入力する前に要素の既存の値をクリアするかどうかを指定するオプション。	データ入力	ブール	False	いいえ
typeDelay	各キーストローク間の遅延時間を秒単位で指定するオプション。	データ入力	倍精度	0.09	いいえ

Setfocus

SAP 画面上の要素にフォーカスを設定します。

WaitForCreate

要素がロードされている間、指定された期間待機します。これにより、すべての動的コントロールをロードできます。

表 : 3. WaitForCreate メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
timeoutInSeconds	メソッドがタイムアウトするまでの時間 (秒単位) です。	データ入力	整数	30 秒	いいえ

GuiButton メソッド

Click

SAP 画面でボタンを選択します。

GuiCheckbox メソッド

Check

SAP 画面のチェックボックスをオンにします。

IsChecked

SAP 画面で要素が選択されている場合は true を返し、要素が選択されていない場合は false を返します。

Uncheck

SAP 画面のチェックボックスをオフにします。

GuiComboBox

Get

SAP 画面のコンボボックスの選択された値を取得します。

GetIconName

SAP 画面上の要素のプロパティアイコン名を取得します。

GetList

SAP 画面のコンボボックスからすべての値のリストを取得します。

Set

渡されたキーに対してコンボボックスの値を設定します。

表 : 4. Set メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
value	コンボボックスに設定する値。	データ入力	文字列	なし	はい
selectedItem	「Key」または「Value」のどちらの値を設定するかを指定するオプション。	データ入力	列挙	なし	はい

GuiCtrlGridView

ClickButtonCell

行番号と列コードで定義されたグリッドセルのボタンを選択します。

表 : 5. ClickButtonCell メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	グリッド内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい
columnCode	グリッドセルの列識別子。	データ入力	文字列	なし	はい

ClickCell

行番号と列コードで定義されたグリッドセルを選択します。

表 : 6. ClickCell メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	グリッド内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい
columnCode	グリッドセルの列識別子。	データ入力	文字列	なし	はい

DeselectAllRows

グリッドで選択されているすべての行の選択を解除します。

GetCellType

行番号と列コードで定義されたグリッドセルのタイプを取得します。

表 : 7. GetCellType メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	グリッド内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい
columnCode	グリッドセルの列識別子。	データ入力	文字列	なし	はい

GetCellValue

行番号と列コードで定義されたグリッドセルの値を取得します。

表 : 8. GetCellValue メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	グリッド内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい
columnCode	グリッドセルの列識別子。	データ入力	文字列	なし	はい

GetColumns

グリッドのアクティブな列ヘッダーのリストを取得します。

GetColumnsKeyValuePair

グリッドの列から列名と列コードをキーと値のペアとして取得します。

GetRowCount

グリッドの行数を取得します。

GetRows

startIndex パラメーターで定義された行から開始して、rowNumber パラメーターで定義されたグリッド行の数を取得します。

表 : 9. GetRows メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
startIndex	行の取得を開始する開始行インデックス。	データ入力	整数	なし	はい
rowNumber	グリッドから取得する行数を示します	データ入力	整数	なし	はい

GetRowsByColumn

startIndex、rowNumber、columnCode の各パラメーターに基づいて、特定の列から行のサブセットを取得します。

表 : 10. GetRowsByColumn メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
startIndex	指定された列 (columnCode) のデータの取得を開始する行の開始インデックス。	データ入力	整数	なし	はい
rowNumber	startIndex から開始して取得する行数。	データ入力	整数	なし	はい
columnCode	行データの取得元の列。	データ入力	文字列	なし	はい

GetSelectedColumns

選択されている列を取得します。

GetSelectedRows

選択されている行を取得します。

GetSingleRow

行番号で定義されたグリッドの特定の行を取得します。

表 : 11. GetSingleRow メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	データを取得するグリッドの行を指定する行インデックス (または行番号)。	データ入力	整数	なし	はい

GetVisibleRows

表示されている行を取得します。

SelectAllRows

グリッドのすべての行を選択します。

SelectCell

行番号と列コードで定義されたグリッドセルを選択します。

表 : 12. SelectCell メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	グリッド内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい
columnCode	グリッドセルの列識別子。	データ入力	文字列	なし	はい

SelectContextMenuItemById

指定した ID に基づいてグリッドからコンテキストメニューアイテムを選択します。

表 : 13. SelectContextMenuItemById メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
Id	選択したいコンテキストメニューアイテムの一意の識別子。	データ入力	文字列	なし	はい

SelectContextMenuItemByPosition

指定した位置に基づいてグリッドからコンテキストメニューアイテムを選択します。

表 : 14. SelectContextMenuItemByPosition メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
menuItemPosition	選択したいコンテキストメニューアイテムの位置。	データ入力	文字列	なし	はい

SelectContextMenuItemByText

指定したテキストに基づいてグリッドからコンテキストメニューアイテムを選択します。

表 : 15. SelectContextMenuItemByText メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
menuItemText	選択したいコンテキストメニューアイテムのテキスト。	データ入力	文字列	なし	はい

SelectSingleRow

行番号で定義されたグリッドの行を選択します。

表 : 16. SelectSingleRow メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	メソッドがグリッド内の行を選択するために使用する行番号。	データ入力	文字列	なし	はい

SelectToolbarMenuItemById

指定した ID に基づいて、グリッドからツールバーメニューアイテムを選択します。

表 : 17. SelectToolbarMenuItemById メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
Id	選択したいツールバーメニューアイテムの一意の識別子。	データ入力	文字列	なし	はい

SelectToolbarMenuItemByPosition

指定した位置に基づいて、グリッドからツールバーのメニューアイテムを選択します。

表 : 18. SelectToolbarMenuItemByPosition メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
menuItemPosition	ツールバー内のメニューアイテムの位置 (またはインデックス)。	データ入力	整数	なし	はい

SelectToolbarMenuItemByText

指定したテキストに基づいて、グリッドからツールバーのメニューアイテムを選択します。

表 : 19. SelectToolbarMenuItemByText メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
menuItemText	選択したいツールバーのメニューアイテムに表示されるテキスト。	データ入力	文字列	なし	はい

SetCellValue

行番号と列コードで定義されたグリッドのセルの値を設定します。

表 : 20. SetCellValue メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
value	セルに値が設定されます。	データ入力	文字列	なし	はい
rowNumber	変更するセルの行番号。	データ入力	整数	なし	はい
columnCode	変更するセルの列のコード (または識別子)。	データ入力	文字列	なし	はい

GuiLabel

GetText

SAP 画面のラベルのテキストを取得します。

GuiPassword

SetText

SAP 画面の Password 要素に、指定された値をパスワードとして設定します。

GuiRadioButton

IsChecked

ラジオボタンが選択されている場合は true を返し、選択されていない場合は false を返します。

Select

SAP 画面でラジオボタンを選択します。

GuiStatusBar

GetStatus

特定の SAP 画面のステータス情報を取得します。

GuiTab

SelectTab

SAP 画面のタブを選択します。

GuiTableControl

DeselectVisibleRow

指定した行番号に基づいて、表示されている行をクリアします。

表 : 21. DeselectVisibleRow メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	テーブル内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい

DeselectAllVisibleRows

選択したすべての行をクリアします。

DeselectRow

指定した行番号に基づいて特定の行をクリアします。

表 : 22. DeselectRow メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	テーブル内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい

GetAllVisibleRows

テーブルに表示されているすべての行を返します。

GetColumnNames

テーブル内のアクティブな列ヘッダーのリストを取得します。

GetMaximumScrollOffset

テーブル内でスクロール可能な最大値を取得します。

表 : 23. GetMaximumScrollOffset メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
type	スクロールのタイプ (水平または垂直) を選択するオプション。	データ入力	列挙	なし	はい

GetScrollPosition

スクロールバーの現在の位置を取得します。

表 : 24. GetScrollPosition メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
type	スクロールのタイプ (水平または垂直) を選択するオプション。	データ入力	列挙	なし	はい

GetSingleRow

行番号で定義されたテーブルの特定の行を取得します。

表 : 25. GetSingleRow メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	テーブル内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい

GetTable

テーブル全体をフェッチします。

GetVisibleRowCount

表示されている行の数を返します。

ScrollDownByOneRow

下にスクロールしてフォーカスを次の行に移動します。

ScrollToHorizontalPosition

水平方向にスクロールして、指定された位置にフォーカスを移動します。

表 : 26. ScrollToHorizontalPosition メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
position	スクロールの位置。	データ入力	整数	なし	はい

ScrollToNextPage

下にスクロールしてフォーカスを次のページに移動します。

ScrollToPreviousPage

上にスクロールして、フォーカスを前のページに移動します。

ScrollToVerticalPosition

垂直方向にスクロールして、指定された位置にフォーカスを移動します。

表 : 27. ScrollToVerticalPosition メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
position	スクロールの位置。	データ入力	整数	なし	はい

ScrollUpByOneRow

上にスクロールして、フォーカスを前の行に移動します。

SelectAllRows

テーブルのすべての行を、表示されているかどうかにかかわらず選択します。

SelectSingleRow

行番号で定義されたテーブルの行を選択します。

表 : 28. GetRowsByColumn メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	テーブル内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい

SelectCell

行番号と列コードで定義されたテーブル内のセルを選択します。

表 : 29. SelectCell メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	テーブル内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい
columnCode	セルの列のコード番号。	データ入力	文字列	なし	はい

SelectVisibleRow

行番号で定義されたテーブルの表示されている行を選択します。

表 : 30. SelectVisibleRow メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
rowNumber	テーブル内のセルの行インデックスまたは行番号。	データ入力	整数	なし	はい

GuiTextBox

GetText

SAP 画面のテキストボックスのテキストを取得します。

SetCaretPosition

SAP 画面のテキストボックス内の指定された位置にキャレットを設定します。

表 : 31. SetCaretPosition メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
position	キャレットの位置。	データ入力	整数	なし	はい

SetText

SAP 画面のテキストボックスに指定された値を設定します。

表 : 32. SetText メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
text	テキストボックスに設定するテキスト値。	データ入力	文字列	なし	はい

GuiTree

Check

SAP 画面のノード内の特定のアイテムを選択します。

表 : 33. Check メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
column	指定されたノード内の列名または識別子。	データ入力	文字列	なし	はい

ClickNodeItem

SAP 画面のノード内の特定のアイテムをクリックします。

表 : 34. ClickNodeItem メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
column	指定されたノード内の列名または識別子。	データ入力	文字列	なし	はい

CollapseNodeItem

SAP 画面で特定のノードアイテムを折りたたみます。

表 : 35. CollapseNodeItem メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい

DoubleClickNode

SAP 画面上の特定のノードに対してダブルクリックのマウスアクションを実行します。

表 : 36. DoubleClickNode メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい

DoubleClickNodeItem

SAP 画面上のノードの特定のアイテムに対してダブルクリックのマウスアクションを実行します。

表 : 37. DoubleClickNodeItem メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
column	指定されたノード内の列名または識別子。	データ入力	文字列	なし	はい

GetColumnsKeyValuePair

ツリーの列から列名と列コードをキーと値のペアとして取得します。

GetTreeType

ツリーのタイプ (シンプル、リスト、列など) を取得します。タイプがこれらのいずれでもない場合、メソッドは空の値を返します。

GetNodeKeyByPath

指定したパスに基づいてノードキーを取得します。

表 : 38. GetNodeKeyByPath メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
path	ツリー内の特定のノードを検索するためのルートまたは階層。	データ入力	文字列	なし	はい

GetNodeKeyByText

指定したテキストに基づいてノードキーを取得します。

表 : 39. GetNodeKeyByText メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeText	ノードキーと照合するテキスト値。 値は、大文字と小文字や余分なスペースを無視して、任意のノードのテキストと照合されます。	データ入力	文字列	なし	はい

GetNodeItemText

指定したキーと名前に基づいてノードアイテムのテキストを取得します。

表 : 40. GetNodeItemText メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
key	ノードに関連付けられたキー。このキーは、テキストを取得するノードの一意の識別子です。	データ入力	文字列	なし	はい
name	ノードのフィルタリングや詳細な識別に使用される、ノード内の特定のアイテムまたはプロパティの名前。	データ入力	文字列	なし	はい

GetSelectedNodes

選択したノードの値を取得します。

GetNodeItemCheckBoxState

ノードアイテムのチェックボックスのステータスを取得します。

表 : 41. GetNodeItemCheckBoxState メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
column	指定されたノード内の列名または識別子。	データ入力	文字列	なし	はい

PressNodeItemButton

SAP 画面上の指定されたノードアイテムのボタンをクリックします。

表 : 42. PressNodeItemButton メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
column	指定されたノード内の列名または識別子。	データ入力	文字列	なし	はい

SelectNodeItem

SAP 画面で指定されたノードアイテムを選択します。

表 : 43. SelectNodeItem メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
column	指定されたノード内の列名または識別子。	データ入力	文字列	なし	はい

SelectNode

SAP 画面で指定されたノードを選択します。

表 : 44. SelectNode メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい

SelectContextMenuItemById

指定した ID に基づいてコンテキストメニューアイテムを選択します。

表 : 45. SelectContextMenuItemById メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
type	コンテキストメニューのタイプ (ツリー、ノード、ノードアイテム)。	データ入力	列挙	なし	はい
menuId	選択する必要があるコンテキストメニューアイテムの識別子。	データ入力	文字列	なし	はい
nodeKey	コンテキストメニューが呼び出されるツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
ColumnName	ノード内の列の名前。これは、コンテキストメニューを適用するノード内の特定の列を絞り込むのに役立ちます。	データ入力	文字列	なし	はい

SelectContextMenuItemByText

指定したテキストに基づいてコンテキストメニューアイテムを選択します。

表 : 46. SelectContextMenuItemByText メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
type	コンテキストメニューのタイプ (ツリー、ノード、ノードアイテム)。	データ入力	列挙	なし	はい
menuText	選択するコンテキストメニューアイテムの表示テキスト。	データ入力	文字列	なし	はい
nodeKey	コンテキストメニューが呼び出されるツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
ColumnName	ノード内の列の名前。この名前は、コンテキストメニューを適用するノード内の特定の列を絞り込むのに役立ちます。	データ入力	文字列	なし	はい

SelectContextMenuItemByPosition

指定した位置に基づいてコンテキストメニューアイテムを選択します。

表 : 47. SelectContextMenuItemByPosition メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
type	コンテキストメニューのタイプ (ツリー、ノード、ノードアイテム)。	データ入力	列挙	なし	はい
menuPosition	選択したいコンテキストメニューアイテムの位置。これは、位置を表すインデックスまたは文字列のいずれかになります。	データ入力	文字列	なし	はい
nodeKey	コンテキストメニューが呼び出されるツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
ColumnName	ノード内の列の名前。この名前は、コンテキストメニューを適用するノード内の特定の列を絞り込むのに役立ちます。	データ入力	文字列	なし	はい

Uncheck

SAP 画面のノード内の特定のアイテムをクリアします。

表 : 48. Uncheck メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
nodeKey	ツリー内の特定のノードの一意の識別子。	データ入力	文字列	なし	はい
column	指定されたノード内の列名または識別子。	データ入力	文字列	なし	はい

GuiUserArea

ScrollToNextPage

下にスクロールしてフォーカスを次のページに移動します。

ScrollToPreviousPage

上にスクロールして、フォーカスを前のページに移動します。

SetHorizontalScroll

指定した値まで水平方向にスクロールします。

表 : 49. SetHorizontalScroll メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
scrolVal	スクロールバーの数値。	データ入力	整数	なし	はい

SetVerticalScroll

指定した値まで垂直方向にスクロールします。

表 : 50. SetVerticalScroll メソッドのパラメーター

パラメーター	説明	データポートエントリタイプ	データタイプ	デフォルト値	必須？
scrolVal	スクロールバーの数値。	データ入力	整数	なし	はい