ファイルに応じた既定のアプリの起動

[アーティクル]
07/13/2023

重要な API

Windows.System.Launcher.LaunchFileAsync

ファイルに応じて既定のアプリを起動する方法について説明します。多くのアプリでは、アプリ自体で処理できないファイルを操作する必要が生じる場合があります。たとえば、さまざまな種類のファイルを受け取るメールアプリは、これらのファイルを既定のハンドラーで起動する手段を備えている必要があります。以下の手順では、Windows.System.Launcher API を使って、アプリがそれ自体で処理できないファイルの既定のハンドラーを起動する方法を示します。

ファイルオブジェクトを取得する

最初にファイルの Windows.Storage.StorageFile オブジェクトを取得します。

ファイルがアプリのパッケージに含まれている場合は、Package.InstalledLocation プロパティで Windows.Storage.StorageFolder オブジェクトを取得し、Windows.Storage.StorageFolder.GetFileAsync メソッドで StorageFile オブジェクトを取得します。

ファイルが既知のフォルダー内にある場合には、Windows.Storage.KnownFolders クラスのプロパティで StorageFolder を取得し、GetFileAsync メソッドで StorageFile オブジェクトを取得します。

ファイルを起動する

Windows には、ファイルの既定のハンドラーを起動するためのいくつかの異なるオプションが用意されています。これらのオプションについて、次の表とセクションで説明します。

オプション	Method	説明
既定の起動	LaunchFileAsync(IStorageFile)	指定されたファイルを既定のハンドラーで起動します。
[プログラムから開く] を使った起動	LaunchFileAsync(IStorageFile, LauncherOptions)	指定されたファイルを [プログラムから開く] ダイアログでユーザーによって選択されたハンドラーを使って起動します。
推奨されるアプリフォールバックを使った起動	LaunchFileAsync(IStorageFile, LauncherOptions)	指定されたファイルを既定のハンドラーで起動します。ハンドラーがシステムにインストールされていない場合は、ストアにあるアプリをユーザーに勧めます。
画面上に留まった適切なビューを使った起動	LaunchFileAsync(IStorageFile, LauncherOptions) (Windows のみ)	指定されたファイルを既定のハンドラーで起動します。起動後も画面上に留まるように指定し、特定のウィンドウサイズを要求します。 LauncherOptions.DesiredRemainingView はモバイルデバイスファミリではサポートされていません。

既定の起動

既定のアプリを起動するには、Windows.System.Launcher.LaunchFileAsync(IStorageFile) メソッドを呼び出します。この例では Windows.Storage.StorageFolder.GetFileAsync メソッドを使って、このアプリパッケージに含まれる画像ファイル test.png を起動します。

async void DefaultLaunch()
{
   // Path to the file in the app package to launch
   string imageFile = @"images\test.png";
   
   var file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile);
   
   if (file != null)
   {
      // Launch the retrieved file
      var success = await Windows.System.Launcher.LaunchFileAsync(file);

      if (success)
      {
         // File launched
      }
      else
      {
         // File launch failed
      }
   }
   else
   {
      // Could not find file
   }
}

async Sub DefaultLaunch()
   ' Path to the file in the app package to launch
   Dim imageFile = "images\test.png"
   Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile)
   
   If file IsNot Nothing Then
      ' Launch the retrieved file
      Dim success = await Windows.System.Launcher.LaunchFileAsync(file)

      If success Then
         ' File launched
      Else
         ' File launch failed
      End If
   Else
      ' Could not find file
   End If
End Sub

Windows::Foundation::IAsyncAction MainPage::DefaultLaunch()
{
    auto installFolder{ Windows::ApplicationModel::Package::Current().InstalledLocation() };

    Windows::Storage::StorageFile file{ co_await installFolder.GetFileAsync(L"images\\test.png") };

    if (file)
    {
        // Launch the retrieved file
        bool success = co_await Windows::System::Launcher::LaunchFileAsync(file);
        if (success)
        {
            // File launched
        }
        else
        {
            // File launch failed
        }
    }
    else
    {
        // Could not find file
    }
}

void MainPage::DefaultLaunch()
{
   auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation;

   concurrency::task<Windows::Storage::StorageFile^getFileOperation(installFolder->GetFileAsync("images\\test.png"));
   getFileOperation.then([](Windows::Storage::StorageFile^ file)
   {
      if (file != nullptr)
      {
         // Launch the retrieved file
         concurrency::task<bool> launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file));
         launchFileOperation.then([](bool success)
         {
            if (success)
            {
               // File launched
            }
            else
            {
               // File launch failed
            }
         });
      }
      else
      {
         // Could not find file
      }
   });
}

[プログラムから開く] を使った起動

LauncherOptions.DisplayApplicationPicker を true に設定して Windows.System.Launcher.LaunchFileAsync(IStorageFile, LauncherOptions) メソッドを呼び出して、ユーザーが [プログラムから開く] ダイアログボックスで選んだアプリを起動します。

ユーザーが特定のファイルに既定以外のアプリを選ぶ場合は、[プログラムから開く] ダイアログボックスを使うことをお勧めします。たとえば、アプリで画像ファイルを起動できる場合、既定のハンドラーは多くの場合ビューアーアプリです。場合によっては、ユーザーが画像の表示ではなく編集を行うこともあります。 [プログラムから開く] オプションを AppBar またはコンテキストメニューで代替コマンドと共に使って、ユーザーが [プログラムから開く] ダイアログを開き、このようなシナリオでエディターアプリを選択できるようにします。

.png ファイルの起動に関するダイアログボックスを開きます。ダイアログには、すべての.pngファイルに対してユーザーの選択を使用するか、このファイルだけを.pngするかを指定するチェックボックスが含まれています。ダイアログには、ファイルを起動するための4つのアプリオプションと「その他のオプション」リンクが含まれています。

async void DefaultLaunch()
{
   // Path to the file in the app package to launch
      string imageFile = @"images\test.png";
      
   var file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile);

   if (file != null)
   {
      // Set the option to show the picker
      var options = new Windows.System.LauncherOptions();
      options.DisplayApplicationPicker = true;

      // Launch the retrieved file
      bool success = await Windows.System.Launcher.LaunchFileAsync(file, options);
      if (success)
      {
         // File launched
      }
      else
      {
         // File launch failed
      }
   }
   else
   {
      // Could not find file
   }
}

async Sub DefaultLaunch()

   ' Path to the file in the app package to launch
   Dim imageFile = "images\test.png"

   Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile)

   If file IsNot Nothing Then
      ' Set the option to show the picker
      Dim options = Windows.System.LauncherOptions()
      options.DisplayApplicationPicker = True

      ' Launch the retrieved file
      Dim success = await Windows.System.Launcher.LaunchFileAsync(file)

      If success Then
         ' File launched
      Else
         ' File launch failed
      End If
   Else
      ' Could not find file
   End If
End Sub

Windows::Foundation::IAsyncAction MainPage::DefaultLaunch()
{
    auto installFolder{ Windows::ApplicationModel::Package::Current().InstalledLocation() };

    Windows::Storage::StorageFile file{ co_await installFolder.GetFileAsync(L"images\\test.png") };

    if (file)
    {
        // Set the option to show the picker
        Windows::System::LauncherOptions launchOptions;
        launchOptions.DisplayApplicationPicker(true);

        // Launch the retrieved file
        bool success = co_await Windows::System::Launcher::LaunchFileAsync(file, launchOptions);
        if (success)
        {
            // File launched
        }
        else
        {
            // File launch failed
        }
    }
    else
    {
        // Could not find file
    }
}

void MainPage::DefaultLaunch()
{
   auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation;

   concurrency::task<Windows::Storage::StorageFile^> getFileOperation(installFolder->GetFileAsync("images\\test.png"));
   getFileOperation.then([](Windows::Storage::StorageFile^ file)
   {
      if (file != nullptr)
      {
         // Set the option to show the picker
         auto launchOptions = ref new Windows::System::LauncherOptions();
         launchOptions->DisplayApplicationPicker = true;

         // Launch the retrieved file
         concurrency::task<bool> launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file, launchOptions));
         launchFileOperation.then([](bool success)
         {
            if (success)
            {
               // File launched
            }
            else
            {
               // File launch failed
            }
         });
      }
      else
      {
         // Could not find file
      }
   });
}

推奨されるアプリフォールバックを使った起動

場合によっては、起動中のファイルを処理するためのアプリがインストールされていないこともあります。既定では、Windows はストア上の適切なアプリを検索するリンクを表示して、これらのケースに対処します。このシナリオで入手するアプリに関する特定の推奨事項を示す場合は、起動中のファイルと共に推奨事項を渡すことができます。そのためには、LauncherOptions.PreferredApplicationPackageFamilyName を推奨するストア内のアプリのパッケージのファミリ名に設定して、Windows.System.Launcher.launchFileAsync(IStorageFile, LauncherOptions) メソッドを呼び出します。その後、LauncherOptions.PreferredApplicationDisplayName をそのアプリの名前に設定します。 Windows ではこの情報を使って、ストア内のアプリを検索する一般的なオプションを、ストアから推奨アプリを入手する固有のオプションに置き換えます。

注意

アプリを推奨するには、これらの両方のオプションを設定する必要があります。どちらか一方のみを設定した場合は、エラーになります。

.contoso ファイル起動のダイアログで開く。.contoso にはマシンにハンドラーがインストールされていないため、ダイアログにはストアアイコンと、ユーザーをストア上の正しいハンドラーを指すテキストを含むオプションが含まれています。ダイアログには、

async void DefaultLaunch()
{
   // Path to the file in the app package to launch
   string imageFile = @"images\test.contoso";

   // Get the image file from the package's image directory
   var file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile);

   if (file != null)
   {
      // Set the recommended app
      var options = new Windows.System.LauncherOptions();
      options.PreferredApplicationPackageFamilyName = "Contoso.FileApp_8wknc82po1e";
      options.PreferredApplicationDisplayName = "Contoso File App";

      // Launch the retrieved file pass in the recommended app
      // in case the user has no apps installed to handle the file
      bool success = await Windows.System.Launcher.LaunchFileAsync(file, options);
      if (success)
      {
         // File launched
      }
      else
      {
         // File launch failed
      }
   }
   else
   {
      // Could not find file
   }
}

async Sub DefaultLaunch()

   ' Path to the file in the app package to launch
   Dim imageFile = "images\test.contoso"

   ' Get the image file from the package's image directory
   Dim file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile)

   If file IsNot Nothing Then
      ' Set the recommended app
      Dim options = Windows.System.LauncherOptions()
      options.PreferredApplicationPackageFamilyName = "Contoso.FileApp_8wknc82po1e";
      options.PreferredApplicationDisplayName = "Contoso File App";

      ' Launch the retrieved file pass in the recommended app
      ' in case the user has no apps installed to handle the file
      Dim success = await Windows.System.Launcher.LaunchFileAsync(file)

      If success Then
         ' File launched
      Else
         ' File launch failed
      End If
   Else
      ' Could not find file
   End If
End Sub

Windows::Foundation::IAsyncAction MainPage::DefaultLaunch()
{
    auto installFolder{ Windows::ApplicationModel::Package::Current().InstalledLocation() };

    Windows::Storage::StorageFile file{ co_await installFolder.GetFileAsync(L"images\\test.png") };

    if (file)
    {
        // Set the recommended app
        Windows::System::LauncherOptions launchOptions;
        launchOptions.PreferredApplicationPackageFamilyName(L"Contoso.FileApp_8wknc82po1e");
        launchOptions.PreferredApplicationDisplayName(L"Contoso File App");

        // Launch the retrieved file, and pass in the recommended app
        // in case the user has no apps installed to handle the file.
        bool success = co_await Windows::System::Launcher::LaunchFileAsync(file, launchOptions);
        if (success)
        {
            // File launched
        }
        else
        {
            // File launch failed
        }
    }
    else
    {
        // Could not find file
    }
}

void MainPage::DefaultLaunch()
{
   auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation;

   concurrency::task<Windows::Storage::StorageFile^> getFileOperation(installFolder->GetFileAsync("images\\test.contoso"));
   getFileOperation.then([](Windows::Storage::StorageFile^ file)
   {
      if (file != nullptr)
      {
         // Set the recommended app
         auto launchOptions = ref new Windows::System::LauncherOptions();
         launchOptions->PreferredApplicationPackageFamilyName = "Contoso.FileApp_8wknc82po1e";
         launchOptions->PreferredApplicationDisplayName = "Contoso File App";
         
         // Launch the retrieved file pass, and in the recommended app
         // in case the user has no apps installed to handle the file.
         concurrency::task<bool> launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file, launchOptions));
         launchFileOperation.then([](bool success)
         {
            if (success)
            {
               // File launched
            }
            else
            {
               // File launch failed
            }
         });
      }
      else
      {
         // Could not find file
      }
   });
}

画面上に留まった適切なビューを使った起動 (Windows のみ)

LaunchFileAsync を呼び出すソースアプリは、ファイルの起動後も画面上に留まることを要求できます。既定では、利用可能なスペース全体がソースアプリとファイルを処理するターゲットアプリとで均等に共有されます。ソースアプリでは、DesiredRemainingView プロパティを使って、利用可能なスペースをソースアプリのウィンドウがどの程度占めるかをオペレーティングシステムに指示できます。この DesiredRemainingView では、ファイルの起動後にソースアプリが画面上に留まる必要がなく、ターゲットアプリに完全に置き換わってもよいことも示せます。このプロパティは呼び出し元アプリの優先ウィンドウのサイズだけを指定します。画面に同時に表示されている可能性のある他のアプリの動作は指定しません。

注意

ソースアプリの最終的なウィンドウサイズは、複数の異なる要素が考慮されて決定されます。たとえば、ソースアプリの設定、画面上のアプリの数、画面の向きなどです。 DesiredRemainingView を設定しても、ソースアプリの特定のウィンドウ動作が保証されるわけではありません。

**モバイルデバイスファミリ: **LauncherOptions.DesiredRemainingView はモバイルデバイスファミリではサポートされていません。

async void DefaultLaunch()
{
   // Path to the file in the app package to launch
   string imageFile = @"images\test.png";
   
   var file = await Windows.ApplicationModel.Package.Current.InstalledLocation.GetFileAsync(imageFile);

   if (file != null)
   {
      // Set the desired remaining view
      var options = new Windows.System.LauncherOptions();
      options.DesiredRemainingView = Windows.UI.ViewManagement.ViewSizePreference.UseLess;

      // Launch the retrieved file
      bool success = await Windows.System.Launcher.LaunchFileAsync(file, options);
      if (success)
      {
         // File launched
      }
      else
      {
         // File launch failed
      }
   }
   else
   {
      // Could not find file
   }
}

Windows::Foundation::IAsyncAction MainPage::DefaultLaunch()
{
    auto installFolder{ Windows::ApplicationModel::Package::Current().InstalledLocation() };

    Windows::Storage::StorageFile file{ co_await installFolder.GetFileAsync(L"images\\test.png") };

    if (file)
    {
        // Set the desired remaining view.
        Windows::System::LauncherOptions launchOptions;
        launchOptions.DesiredRemainingView(Windows::UI::ViewManagement::ViewSizePreference::UseLess);

        // Launch the retrieved file.
        bool success = co_await Windows::System::Launcher::LaunchFileAsync(file, launchOptions);
        if (success)
        {
            // File launched
        }
        else
        {
            // File launch failed
        }
    }
    else
    {
        // Could not find file
    }
}

void MainPage::DefaultLaunch()
{
   auto installFolder = Windows::ApplicationModel::Package::Current->InstalledLocation;

   concurrency::task<Windows::Storage::StorageFile^> getFileOperation(installFolder->GetFileAsync("images\\test.png"));
   getFileOperation.then([](Windows::Storage::StorageFile^ file)
   {
      if (file != nullptr)
      {
         // Set the desired remaining view.
         auto launchOptions = ref new Windows::System::LauncherOptions();
         launchOptions->DesiredRemainingView = Windows::UI::ViewManagement::ViewSizePreference::UseLess;

         // Launch the retrieved file.
         concurrency::task<bool> launchFileOperation(Windows::System::Launcher::LaunchFileAsync(file, launchOptions));
         launchFileOperation.then([](bool success)
         {
            if (success)
            {
               // File launched
            }
            else
            {
               // File launch failed
            }
         });
      }
      else
      {
         // Could not find file
      }
   });
}

注釈

起動するアプリをアプリが選ぶことはできません。どのアプリを起動するかはユーザーが決めます。ユーザーは、ユニバーサル Windows プラットフォーム (UWP) アプリまたは Windows デスクトップアプリを選択できます。

ファイルの起動時、アプリはユーザーに表示されるフォアグラウンドアプリである必要があります。この要件は、ユーザーが制御を維持するのに役立ちます。この要件を満たすために、すべてのファイル起動がアプリの UI に直接結び付けられていることを確認します。ほとんどの場合、ファイル起動を開始するには、常にユーザーがなんらかの操作を行う必要があります。

.exe、.msi、.js ファイルなど、オペレーティングシステムによって自動的に実行されるコードまたはスクリプトを含むファイルの種類を起動することはできません。この制約により、オペレーティングシステムを変更する可能性のある、悪意のあるファイルからユーザーを保護できます。この方法では、.docx ファイルなど、スクリプトを分離するアプリによって実行されるスクリプトを含むファイルの種類を起動できます。 Microsoft Word などのアプリは、.docx ファイルのスクリプトがオペレーティングシステムを変更しないようにします。

制限されている種類のファイルを起動しようとすると、起動は失敗し、エラーコールバックが呼び出されます。アプリがさまざまな種類のファイルを処理するため、このエラーの発生が予想される場合は、ユーザーにフォールバックを提供することをお勧めします。たとえば、ファイルをデスクトップに保存してそこで開けるようなオプションをユーザーに提供することができます。

タスク

ガイドライン

ファイルの種類と URI のガイドライン

ファイルに応じた既定のアプリの起動

ファイルオブジェクトを取得する

ファイルを起動する

既定の起動

[プログラムから開く] を使った起動

画面上に留まった適切なビューを使った起動 (Windows のみ)

注釈

タスク

ガイドライン

リファレンス

フィードバック

フィードバック

その他のリソース

ファイルに応じた既定のアプリの起動

ファイル オブジェクトを取得する

ファイルを起動する

既定の起動

[プログラムから開く] を使った起動

画面上に留まった適切なビューを使った起動 (Windows のみ)

注釈

関連トピック

タスク

ガイドライン

リファレンス

フィードバック

フィードバック

その他のリソース

ファイルオブジェクトを取得する