UI Automation のアクティビティ

最終更新日時 2024年12月20日

画像上でホバー

UiPath.Core.Activities.HoverImage

UI 要素の中で画像を検索し、画像の上にカーソルを置きます (画像の上でホバーします)。

プロパティ

入力

Image.Image - 検索する既存の画像です。このフィールドでは Image 変数のみサポートされています。
Image.Accuracy - 検索しようとする画像と実際に見つける画像との間の最低限の類似度を表す 0 ～ 1 の測定単位です。見つける画像が検索しようとする画像とわずかに異なる場合に便利です。既定値は 0.8 です。
Image.Profile - 使用する画像検出アルゴリズムを変更することができます。 Basic は、平均的な速度とリソースコストを持つ古典的なアルゴリズムです。 Enhanced は、より多くのリソースを犠牲にして、より正確な結果を提供することができます。既定では、このフィールドはBasic に設定されています。
Target.Selector - アクティビティの実行時に特定の UI 要素の検索に使用する Text プロパティです。実際には、検索しようとする GUI 要素とそのいくつかの親要素の属性を指定する XML フラグメントです。
Target.TimeoutMS - アクティビティの実行が完了するまで待機する時間をミリ秒で指定します。指定した時間が経過しても実行が完了しない場合には、SelectorNotFoundException 例外をスローします。既定値は 30000 ミリ秒 (30 秒) です。
Target.WaitForReady - アクションを実行する前に、ターゲットが準備完了になるまで待ちます。次のオプションを使用できます。
- NONE - ターゲット要素以外の要素の読み込みを待たずに、アクションを実行します。たとえば、UI 要素がすべて読み込まれるまで待つことなく、Web ページからテキストを取得したり、特定のボタンをクリックしたりする場合に、このオプションを使用できます。ボタンがまだ読み込まれていない要素 (スクリプトなど) に依存している場合、これは望ましくない結果を招く可能性があります。
- Interactive/Complete - 実際に操作を実行する前に、対象アプリのすべての UI 要素が存在するようになるまで待ちます。
  
  アプリケーションが対話または完了のどちらのステートにあるか調べるには、以下のタグを検証します。
- Desktop applications - <wnd> タグ、<ctrl> タグ、<java> タグ、または <uia> タグの存在を確認するために wm_null メッセージが送信されます。存在する場合、アクティビティが実行されます。
- Web アプリケーション：
1. Internet Explorer - <webctrl> タグは、HTML ドキュメントの Ready ステートが Complete に設定されているかどうかを確認するために使用されます。また、Busy ステートは「False」に設定されている必要があります。
2. Others - <webctrl> タグは、HTML ドキュメントの Ready ステートが Complete であるかどうかを確認するために使用されます。
- SAP applications - 最初に <wnd> タグを確認した後、SAP 固有の API を使用して、セッションがビジーかどうかを検出します。
Target.Element - 別のアクティビティから返される UiElement 変数を使用します。このプロパティを Selector プロパティと一緒に使用することはできません。このフィールドでは UiElement 変数のみサポートされています。
Target.ClippingRegion - UiElement を基準とし、左、上、右、下の方向で、クリッピング四角形 (ピクセル単位) を定義します。正と負の両方の値をサポートしています。

オプション

ウィンドウメッセージを送信 - このチェックボックスをオンにした場合は、ターゲットアプリケーションに指定のメッセージを送信してホバーを実行します。この入力メソッドの方が高速であり、バックグラウンドで動作します。既定では、このチェックボックスはオフになっています。チェックボックスがオフの場合は、既定のメソッドがハードウェアドライバーを使用してホバーを実行します。既定のメソッドの方が低速であり、バックグラウンドで動作できませんが、すべてのデスクトップアプリケーションに対して使用できます。
KeyModifiers - キー修飾子を追加できます。使用できるオプションは、Alt、Ctrl、Shift、Win です。

注: KeyModifiers は、SendWindowMessages オプションと共に使用することはできません。オプションの組み合わせを持つアクティビティを含むワークフローを実行しても、エラーはスローされません。
CursorPosition.OffsetX - Position フィールドで選択したオプションに従って生じるカーソル位置の水平方向の変位です。
CursorPosition.OffsetY - Position フィールドで選択したオプションに従って生じるカーソル位置の垂直方向の変位です。
CursorPosition.Position - OffsetX プロパティと OffsetY プロパティからのオフセットが追加されるカーソルの開始位置を表します。使用できるオプションは、TopLeft、TopRight、BottomLeft、BottomRight、Center です。既定のオプションは Center です。

共通

表示名 - アクティビティの表示名です。
待機 (ミリ秒) - アクティビティの実行後の遅延時間 (ミリ秒単位) です。既定の時間は 300 ミリ秒です。
実行前の待機時間 - アクティビティが何らかの操作の実行を開始する前の遅延時間 (ミリ秒単位) です。既定の時間は 200 ミリ秒です。
エラー発生時に実行を継続 - アクティビティが例外をスローした場合でも、ワークフローを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白で例外がスローされると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

注: このアクティビティが [トライキャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。

その他

プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

[画像上でホバー] アクティビティの使用例

[画像上でホバー] アクティビティは、UI 要素の中で画像を検索し、その上にホバーするのに使用されます。

このアクティビティの使用方法を例示するために、ブラウザーを開き、画像にホバーして、アクションを開始し、そのアクションに関連する結果を表示する例を作成しました。

サンプルと同等のオートメーションプロセスは以下のように構築できます。

Studio を開いて、新しいプロセスを作成します。
[シーケンス] アクティビティをワークフローデザイナーにドラッグします。
[ブラウザーを開く] アクティビティを [シーケンス] コンテナー内部にドラッグします。
- [プロパティ] パネルで、[ブラウザーの種類] ドロップダウンリストから IE オプションを選択します。
- 式 "https://www.goodreads.com/book/show/7144.Crime_and_Punishment" を Url フィールドに追加します。
- [新しいセッション] オプションのチェックボックスをオンにします。このオプションにより、選択したブラウザーの新しいセッションが開始されます。
[画像上でホバー] アクティビティを [ブラウザーを開く] アクティビティの [本体] コンテナー内にドラッグします。
- 以前 [ブラウザーを開く] アクティビティに追加された Web サイトのアドレスを開きます。
- [画像上でホバー] アクティビティから [クリックしてオプションメニューを開きます] ボタンを選択し、[画面から取り込む] オプションを選択します。希望の画像を選択します。
[画像をクリック] アクティビティを、[画像上でホバー] アクティビティの下にドラッグします。
- [プロパティ] パネルで、[クリックの種類] ドロップダウンリストから CLICK_SINGLE オプションを選択します。
- MouseButton ドロップダウンリストから BTN_LEFT オプションを選択します。
- Target ドロップダウンリストから Target オプションを選択します。
- 式 "<html title='*' /><webctrl aaname='Other editions' parentid='imagecol' tag='A' />" を Selector (セレクタ) フィールドに追加します。
- WaitForReady ドロップダウンリストから INTERACTIVE オプションを選択します。
プロセスを実行します。ロボットは新しいブラウザーを開き、Web サイトにアクセスして、選択した画像にホバーして、[その他のエディション] ボタンをクリックします。