UI Automation API

API を使用すると、[パッケージを管理] メニューで提供されているサービスにアクセスして操作することができます。これらの API は、コード化されたオートメーションを設計する際に使用できます。コード化されたオートメーションと、API を使用してそれらのオートメーションを設計する方法について詳しくは、こちらをご覧ください。

注: [定義に移動] (F12) を使用すると、特定のサービスの UiPath API の定義にアクセスできます。コード化されたオートメーションを実装する場合は、直接公開されている API のみを使用することをお勧めします。サービスで直接公開されていないその他の API は、事前の通知なしに変更される場合があります。

オーバーロード

API には多くの場合、過剰な負荷があります。つまり、パラメーターオプションが異なる同じメソッドの複数のバージョンを提供します。オーバーロードすると、特定の要件に基づいて API の動作をカスタマイズできます。たとえば、UI Automation API には、UI 要素が表示されるまでの最大時間を指定するタイムアウトパラメーターを受け入れるオーバーロードが設定されている場合があります。

API をそれぞれのオーバーロードで使用することで、目的のオートメーションのロジックと動作を簡単に実現できます。

UI Automation API

このセクションには、UiPath.UIAutomationNext.API.Contracts サービスの API が含まれています。

API	説明
添付	UI 操作の自動化で使用するために、既に開いているデスクトップアプリケーションまたは Web ブラウザーページにフォーカスします。
チェック	チェックボックスまたはラジオボタンのオンオフを切り替えます。
クリック	ボタンやリンクなど、指定した UI 要素をクリックします。ユースケースに応じて、クリックアクションをさらに設定できます。
ClosePopup	アプリケーションの全面にあるすべてのポップアップを閉じます。
ドラッグアンドドロップ	ソース UI 要素からターゲット UI 要素へのドラッグアンドドロップ操作を実行します。
データを抽出	データをデータテーブルとして抽出します。
属性を取得	指定した UI 要素が持つ特定の属性の値を取得します。
Getchildren	指定したターゲットの子を取得します。
GetRuntimeTarget	指定したターゲットのランタイムターゲットを取得します。
GetText	UI 要素からテキストを抽出してコピーします。
URL を取得	現在の Web ページから URL を取得します。
GoToUrl	指定した Web ブラウザーで、指定した URL に移動します。
強調表示	選択した UI 要素を強調表示します。
ホバー	現在の Web ページから URL を取得します。
IsEnabled	UI 要素が有効化されているかどうかを確認します。
キーボードショートカット	UI 要素に 1 つ以上のキーボードショートカットを送信します。
マウススクロール	アプリケーション内でマウススクロールイベントを送信し、指定した UI 要素までのスクロールを可能にします。
開く	UI 操作を自動化するときに使用するデスクトップアプリケーションまたは Web ブラウザーを開きます。
項目を選択	ドロップダウンコンボボックスまたはリストボックスから項目を選択します。
SetRuntimeBrowser	現在アクティブなランタイムブラウザーを設定します。
SetValue	入力ボックス、ドロップダウン、チェックボックス、ラジオボタンなどの任意の入力フィールドに値を設定します。
スクリーンショットを作成	指定した UI 要素またはアプリケーションのスクリーンショットを作成して、ファイルに保存します。
文字を入力	テキストボックスなどの指定した UI 要素にテキストを入力します。Tab や Enter などの特殊キーを UI 要素に送信することもできます。
WaitState	要素がユーザーインターフェイスで表示されているか、それとも消滅しているかを検証して、アプリケーションまたは Web ブラウザーのステートを確認します。

UI Automation API を使用する

UI Automation API を UI 要素と組み合わせて使用できます。UI アプリケーションを自動化するプロセスでは、目的のアプリケーションを開くか、アプリケーションにフォーカスしてから、その UI 要素を自動化する必要があります。UI Automation API を使用してアプリケーションを自動化するには、以下の手順を実行します。

Attach および Open API を使用するときは、UI Automation サービスを呼び出します。これらの API は、アプリケーションや Web ブラウザーを開いたりフォーカスしたりするために、単独で使用されます。
1. オブジェクトリポジトリに記述子としてキャプチャされた UI 要素を操作する場合は、Open API または Attach API を IScreenDescriptor オーバーロードと共に使用します。
  uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
2. ネイティブセレクターの場合は、UI Explorer を使用してアプリケーションの <app/> タグをコピーし、Open API を TargetAppModel オーバーロードと共に使用します。
  var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"))
UI 要素上で直接 UI Automation API を呼び出します。
1. オブジェクトリポジトリに記述子としてキャプチャされた UI 要素を操作する場合は、他の API を IElementDescriptor オーバーロードと共に使用します。
```
var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello")var applicationScreen = uiAutomation.Open(ObjectRepository.Decriptors.<ApplicationName>.<ScreenName>)
applicationScreen.TypeInto(ObjectRepository.Descriptors.<ApplicationName>.<ScreenName>.<ElementName>, "Hello")
```
2. ネイティブセレクターの場合は、UI Explorer を使用して要素の <webctrl/> タグをコピーし、残りの API を TargetAnchorableModel オーバーロードと共に使用します。
```
var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"));
applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")var applicationScreen = uiAutomation.Open(Target.FromSelector("<html app = 'chrome.exe'/>"));
applicationScreen.TypeInto(Target.FromSelector("<webctrl id='generalClick' tag='BUTTON'/>"), "Hello")
```