開く

UI 操作を自動化するときに使用するデスクトップ アプリケーションまたは Web ブラウザーを開きます。

この API を使用するには、uiAutomation.API() の形式で UI Automation サービスを呼び出します。例: uiAutomation.Open()

定義

名前空間: UiPath.UIAutomationNext.API.Contracts

アセンブリ: UiPath.UIAutomationNext.API.Contracts (UiPath.UIAutomationNext.API.Contracts dll 内)

オーバー ロード

オーバーロード	説明
Open(String, TargetAppOptions, String, String)	オブジェクト リポジトリの画面名で識別される、UI 操作の自動化で使用する特定のデスクトップ アプリケーションまたは Web ページを開きます。
Open(TargetAppModel, TargetAppOptions)	TargetAppModel オブジェクトで識別される、UI 操作の自動化で使用する特定のデスクトップ アプリケーションまたは Web ページを開きます。
Open(String, String, String, NAppOpenMode, NWindowResize, NInteractionMode)	オブジェクト リポジトリの画面名で識別される、UI 操作の自動化で使用する特定のデスクトップ アプリケーションまたは Web ページを開きます。同時に、アプリケーションまたは Web ページのその他のカスタマイズも行います。

Open(String, TargetAppOptions, String, String)

オブジェクト リポジトリの画面名で識別される、UI 操作の自動化で使用する特定のデスクトップ アプリケーションまたは Web ページを開きます。

Open(
    string screenName,  
    TargetAppOptions targetAppOptions, 
    [string appName],
    [string appVersion])

screeName 文字列

オブジェクト リポジトリ内に記録される文字列としてフォーカスする画面の名前です。

targetAppOptions

アプリケーションまたは Web ページにアタッチするための追加のオプションと設定:

• Timeout Double - エラーをスローする前にアクティビティの実行を待機する秒数を指定します。既定値は 30 秒です。リモート デスクトップ環境でウィンドウを指定する場合、タイムアウトの既定の設定は 60 秒です。
• InteractionMode NInteractionMode:
  • HardwareEvents - ハードウェア ドライバーを使用してアクションを実行します。動作が極めて遅く、バックグラウンドでは動作しませんが、すべてのデスクトップ アプリに対して使用できます。
  • Simulate - アクセシビリティ API を使用してアクションをシミュレートします。ブラウザー操作のオートメーション、Java アプリ、SAP に適しています。ハードウェア イベントよりも信頼性が高いメソッドです。すべてのテキストを 1 回のアクションで送信します。対象のアプリケーションにフォーカスしていなくても動作します。対象のアプリケーションの UI 要素がこのメソッドをサポートしているかどうかをテストしてください。
  • DebuggerApi - デバッガー API を使用してアクションを実行します。これは、Chromium の要素に対してのみ動作します。すべてのテキストを一度に送信します。対象のアプリにフォーカスしていなくても動作します。詳しくは、こちらをご覧ください。
  • WindowMessages - Win32 メッセージを使用して、マウスとキーボードの入力を送信します。デスクトップ アプリに適しています。通常はハードウェア イベントよりも信頼性が高くなります。すべてのテキストを 1 回のアクションで送信します。対象のアプリにフォーカスしていなくても動作します。対象のアプリケーションの UI 要素がこのメソッドをサポートしているかどうかをテストしてください。
  • Background - アクションをバックグラウンドで実行します。可能な場合は Simulate または Chromium API の使用を試みます。複雑な API (画像、ネイティブ テキスト) は、通常どおりフォアグラウンドで実行されます。この API は、実行を検証機能と組み合わせて使用することを強くお勧めします。
• OpenMode NAppOpenMode - アプリを開くタイミングを選択します。
  • Never (アプリケーションを開くことはありません。)
  • IfNotOpen (アプリケーションが閉じている場合にのみ開きます。これが既定値です。FilePath または URL が指定されている場合にのみ機能します。)
  • Always (アプリケーションのインスタンスが既に開いている場合でも、別のインスタンスを開きます。FilePath または URL が指定されている場合にのみ機能します。)
• WindowResize NWindowResize - ウィンドウのサイズを選択します。
  • None
  • 最大化
  • 元に戻す
  • 最小化
• UserDataFolderMode BrowserUserDataFolderMode - 設定する UserDataFolderMode です。特定のユーザー データ フォルダーでブラウザーを開始するために使用します。
  • Automatic - ピクチャ イン ピクチャ モードの場合は既定のモードと異なるフォルダーを使用します。UserDataFolderPath が設定されていない場合はフォルダーが自動で生成されます。
  • DefaultFolder - ブラウザーがメインまたは PIP セッションのどちらで実行されても、既定のブラウザー フォルダーを使用します。
  • CustomFolder - UserDataFolderPath で指定したフォルダー、または UserDataFolderPath が設定されていない場合に自動生成されたパスを使用します。
• UserDataFolderPath String - ブラウザーが使用するユーザー データ フォルダーです。設定されていない場合、既定で %LocalAppData%\UiPath\PIP Browser Profiles\BrowserType になります。
• IsIncognito Boolean - ブラウザーをシークレット モードで開く場合は True を入力します。既定では False に設定されています。
• WebDriverMode NWebDriverMode - 新しいブラウザー セッションを開くときの WebDriver の使用方法を指定します。次のオプションが利用できます。
  • Disabled - WebDriver の使用を無効化します。
  • WithGUI - ブラウザーの GUI が表示されます。
  • Headless - ブラウザーは GUI なしでサイレントに起動されます。

appName 文字列

アタッチするアプリケーションの名前です。このパラメーターはデスクトップ アプリケーションに適用されます。

appVersion 文字列

アタッチ先のアプリケーションのバージョンです。このパラメーターはデスクトップ アプリケーションに適用されます。

Open(TargetAppModel, TargetAppOptions)

TargetAppModel オブジェクトで識別される、UI 操作の自動化で使用する特定のデスクトップ アプリケーションまたは Web ページを開きます。

Open(
    TargetAppModel targetApp,
    [TargetAppOptions targetAppOptions])

targetApp TargetAppModel

アタッチする対象のアプリケーションまたは Web ページです。これは、アプリケーションに関する情報を提供する TargetAppModel タイプのオブジェクトです。

• Selector - ユーザー インターフェイス要素の属性を格納する XML フラグメント。
• FilePath - アプリケーションが Web ブラウザーではない場合、開く実行可能ファイルのフル パスを指定します。
• Arguments - アプリケーションが Web ブラウザーでない場合、起動時に対象のアプリケーションに渡すパラメーターを指定できます。
• Url - アプリケーションが Web ブラウザーの場合、開く Web ページの URL を指定します。
• Title - アプリケーションまたはブラウザーのタイトルです。

targetAppOptions

アプリケーションまたは Web ページにアタッチするための追加のオプションと設定:

• Timeout Double - エラーをスローする前にアクティビティの実行を待機する秒数を指定します。既定値は 30 秒です。リモート デスクトップ環境でウィンドウを指定する場合、タイムアウトの既定の設定は 60 秒です。
• InteractionMode NInteractionMode:
  • HardwareEvents - ハードウェア ドライバーを使用してアクションを実行します。動作が極めて遅く、バックグラウンドでは動作しませんが、すべてのデスクトップ アプリに対して使用できます。
  • Simulate - アクセシビリティ API を使用してアクションをシミュレートします。ブラウザー操作のオートメーション、Java アプリ、SAP に適しています。ハードウェア イベントよりも信頼性が高いメソッドです。すべてのテキストを 1 回のアクションで送信します。対象のアプリケーションにフォーカスしていなくても動作します。対象のアプリケーションの UI 要素がこのメソッドをサポートしているかどうかをテストしてください。
  • DebuggerApi - デバッガー API を使用してアクションを実行します。これは、Chromium の要素に対してのみ動作します。すべてのテキストを一度に送信します。対象のアプリにフォーカスしていなくても動作します。詳しくは、こちらをご覧ください。
  • WindowMessages - Win32 メッセージを使用して、マウスとキーボードの入力を送信します。デスクトップ アプリに適しています。通常はハードウェア イベントよりも信頼性が高くなります。すべてのテキストを 1 回のアクションで送信します。対象のアプリにフォーカスしていなくても動作します。対象のアプリケーションの UI 要素がこのメソッドをサポートしているかどうかをテストしてください。
  • Background - アクションをバックグラウンドで実行します。可能な場合は Simulate または Chromium API の使用を試みます。複雑な API (画像、ネイティブ テキスト) は、通常どおりフォアグラウンドで実行されます。この API は、実行を検証機能と組み合わせて使用することを強くお勧めします。
• OpenMode NAppOpenMode - アプリを開くタイミングを選択します。
  • Never (アプリケーションを開くことはありません。)
  • IfNotOpen (アプリケーションが閉じている場合にのみ開きます。これが既定値です。FilePath または URL が指定されている場合にのみ機能します。)
  • Always (アプリケーションのインスタンスが既に開いている場合でも、別のインスタンスを開きます。FilePath または URL が指定されている場合にのみ機能します。)
• WindowResize NWindowResize - ウィンドウのサイズを選択します。
  • None
  • 最大化
  • 元に戻す
  • 最小化
• UserDataFolderMode BrowserUserDataFolderMode - 設定する UserDataFolderMode です。特定のユーザー データ フォルダーでブラウザーを開始するために使用します。
  • Automatic - ピクチャ イン ピクチャ モードの場合は既定のモードと異なるフォルダーを使用します。UserDataFolderPath が設定されていない場合はフォルダーが自動で生成されます。
  • DefaultFolder - ブラウザーがメインまたは PIP セッションのどちらで実行されても、既定のブラウザー フォルダーを使用します。
  • CustomFolder - UserDataFolderPath で指定したフォルダー、または UserDataFolderPath が設定されていない場合に自動生成されたパスを使用します。
• UserDataFolderPath String - ブラウザーが使用するユーザー データ フォルダーです。設定されていない場合、既定で %LocalAppData%\UiPath\PIP Browser Profiles\BrowserType になります。
• IsIncognito Boolean - ブラウザーをシークレット モードで開く場合は True を入力します。既定では False に設定されています。
• WebDriverMode NWebDriverMode - 新しいブラウザー セッションを開くときの WebDriver の使用方法を指定します。次のオプションが利用できます。
  • Disabled - WebDriver の使用を無効化します。
  • WithGUI - ブラウザーの GUI が表示されます。
  • Headless - ブラウザーは GUI なしでサイレントに起動されます。

Open(String, String, String, NAppOpenMode, NWindowResize, NInteractionMode)

オブジェクト リポジトリの画面名で識別される、UI 操作の自動化で使用する特定のデスクトップ アプリケーションまたは Web ページを開きます。同時に、アプリケーションまたは Web ページのその他のカスタマイズも行います。

Open(
    string screenName,
    [string appName],
    [string appVersion],
    [NAppOpenMode openMode],
    [NWindowResize windowResize],
    [NInteractionMode interactionMode])

screeName 文字列

オブジェクト リポジトリ内に記録される文字列としてフォーカスする画面の名前です。

appName 文字列

アタッチするアプリケーションの名前です。このパラメーターはデスクトップ アプリケーションに適用されます。

appVersion 文字列

アタッチ先のアプリケーションのバージョンです。このパラメーターはデスクトップ アプリケーションに適用されます。

openMode NAppOpenMode

オートメーションの実行対象のアプリケーションを開くタイミングを選択します。

• Never (アプリケーションを開くことはありません。)
• IfNotOpen (アプリケーションが閉じている場合にのみ開きます。これが既定値です。Url パラメーターが設定されている場合にのみ機能します。)
• Always (アプリケーションのインスタンスが既に開いている場合でも、別のインスタンスを開きます。Url が設定されている場合にのみ機能します。)

NWindowResize

ウィンドウのサイズを、以下より選択します。

• None
• 最大化
• 元に戻す
• 最小化

NInteractionMode

ロボットが対象のアプリケーションと対話する API を、以下より選択します。

• HardwareEvents - ハードウェア ドライバーを使用してアクションを実行します。動作が極めて遅く、バックグラウンドでは動作しませんが、すべてのデスクトップ アプリに対して使用できます。
• Simulate - アクセシビリティ API を使用してアクションをシミュレートします。ブラウザー操作のオートメーション、Java アプリ、SAP に適しています。ハードウェア イベントよりも信頼性が高いメソッドです。すべてのテキストを 1 回のアクションで送信します。対象のアプリケーションにフォーカスしていなくても動作します。対象のアプリケーションの UI 要素がこのメソッドをサポートしているかどうかをテストしてください。
• DebuggerApi - デバッガー API を使用してアクションを実行します。これは、Chromium の要素に対してのみ動作します。すべてのテキストを一度に送信します。対象のアプリにフォーカスしていなくても動作します。詳しくは、こちらをご覧ください。
• WindowMessages - Win32 メッセージを使用して、マウスとキーボードの入力を送信します。デスクトップ アプリに適しています。通常はハードウェア イベントよりも信頼性が高くなります。すべてのテキストを 1 回のアクションで送信します。対象のアプリにフォーカスしていなくても動作します。対象のアプリケーションの UI 要素がこのメソッドをサポートしているかどうかをテストしてください。
• Background - アクションをバックグラウンドで実行します。可能な場合は Simulate または Chromium API の使用を試みます。複雑な API (画像、ネイティブ テキスト) は、通常どおりフォアグラウンドで実行されます。この API は、実行を検証機能と組み合わせて使用することを強くお勧めします。

WebDriverMode をヘッドレスとして実行する

ヘッドレス構成で WebDriverMode を操作するには、以下の手順に従ってください。

まず、画面の変数を定義します。uiAutomation.Open 関数を使用して、任意のブラウザー (この例では Edge) で新しいアプリケーションを開きます。その後、オーバーロードで Options クラスを使用して特定のブラウザー オプションを指定します。これらのオプションのうち、webDriverMode を NWebDriverMode.Headless に設定します。

対応するコードは以下のようになります。

var screen = uiAutomation.Open(Descriptors.NewApplication.Edge, Options.AppOpen().WithBrowserOptions(webDriverMode: NWebDriverMode.Headless));

このコードは、WebDriver をヘッドレス モードに設定し、ブラウザーを開いて表示しなくてもそのブラウザーを自動化できるようにします。