ファイルのアクティブ化の処理

[Windows 10 の UWP アプリ向けに更新。 Windows 8.x の記事については、「アーカイブ」をご覧ください]

重要な API

アプリは、特定のファイルの種類の既定のハンドラーとして登録することができます。 Windows デスクトップ アプリケーションとユニバーサル Windows プラットフォーム (UWP) アプリの両方を、既定のファイル ハンドラーとして登録できます。 ユーザーがアプリを特定のファイルの種類の既定のハンドラーとして選ぶと、アプリはその種類のファイルを起動したときにアクティブ化されます。

ファイルの種類に登録するのは、その種類のファイルのすべてのファイル起動を処理する場合のみにすることをお勧めします。 アプリをそのファイルの種類に内部的にのみ使う場合、既定のハンドラーに登録する必要はありません。 ファイルの種類に登録する場合は、そのファイルの種類のためにアプリをアクティブ化した際に期待される機能をエンド ユーザーに提供する必要があります。 たとえば、.jpg ファイルを表示する画像ビューアー アプリを登録できます。 ファイルの関連付けについて詳しくは、「ファイルの種類と URI のガイドライン」をご覧ください。

以下の手順では、カスタムのファイルの種類 .alsdk を登録する方法と、ユーザーによって .alsdk ファイルが起動されたときにアプリをアクティブ化する方法について説明します。

UWP アプリでは、組み込みのアプリとオペレーティング システムで使うために、特定の URI とファイル拡張子が予約されています。 予約されている URI またはファイル拡張子にアプリを登録しようとしても無視されます。 詳しくは、「予約済みのファイルと URI スキーム名」をご覧ください。

ステップ 1: パッケージ マニフェストに拡張点を指定する

アプリは、パッケージ マニフェストに一覧表示されるファイル拡張子のアクティブ化イベントだけを受け取ります。 アプリが .alsdk 拡張子を持つファイルを処理することを示す方法は次のとおりです。

  1. ソリューション エクスプローラーで、package.appxmanifest をダブルクリックしてマニフェスト デザイナーを開きます。 [宣言] タブを選び、[使用可能な宣言] ドロップダウンから [ファイルの種類の関連付け] を選んで [追加] をクリックします。 ファイルの関連付けで使われる識別子について詳しくは、「プログラムの識別子」をご覧ください。

    マニフェスト デザイナーで指定することができる各フィールドについて、以下で簡単に説明します。

フィールド 説明
表示名 ファイルの種類のグループの表示名を指定します。 表示名は、コントロール パネル[既定のプログラムを設定する] でファイルの種類を識別するために使われます。
ロゴ デスクトップとコントロール パネル[既定のプログラムを設定する] でファイルの種類を識別するために使われるロゴを指定します。 ロゴを指定しない場合は、アプリケーションの小さいロゴが使われます。
InfoTip ファイルの種類のグループの InfoTip を指定します。 このヒントのテキストは、ユーザーがこの種類のファイルのアイコンの上にマウス ポインターを置くと表示されます。
名前 同じ表示名、ロゴ、InfoTip、編集フラグを共有するファイルの種類のグループの名前を選びます。 このグループ名は、アプリの更新後も維持される名前にします。 名前はすべて小文字である必要があります。
コンテンツの種類 特定のファイルの種類の MIME コンテンツの種類 (image/jpeg など) を指定します。 許可されるコンテンツの種類に関する重要な注意: MIME コンテンツの種類のうち、application/force-downloadapplication/octet-streamapplication/unknownapplication/x-msdownload は予約または禁止されているため、パッケージ マニフェストに入力できません。
ファイルの種類 登録するファイルの種類を指定します。先頭にはピリオドを付けます (例: ".jpeg")。 予約および禁止されているファイルの種類: 予約または禁止されているために UWP アプリを登録できない組み込みアプリ用のファイルの種類の一覧 (アルファベット順) については、「予約済みのファイルと URI スキーム名」をご覧ください。
  1. [名前]alsdk と入力します。
  2. [ファイルの種類].alsdk と入力します。
  3. [ロゴ] に「images\Icon.png」と入力します。
  4. Ctrl + S キーを押して、変更を package.appxmanifest に保存します。

上記の手順により、次のような Extension 要素がパッケージ マニフェストに追加されます。 windows.fileTypeAssociation カテゴリは、アプリが .alsdk 拡張子を持つファイルを処理することを示しています。

      <Extensions>
        <uap:Extension Category="windows.fileTypeAssociation">
          <uap:FileTypeAssociation Name="alsdk">
            <uap:Logo>images\icon.png</uap:Logo>
            <uap:SupportedFileTypes>
              <uap:FileType>.alsdk</uap:FileType>
            </uap:SupportedFileTypes>
          </uap:FileTypeAssociation>
        </uap:Extension>
      </Extensions>

ステップ 2: 適切なアイコンを追加する

ファイルの種類の既定となるアプリは、そのアイコンがシステムのさまざまな場所に表示されます。 アイコンは、たとえば次の場所に表示されます。

  • エクスプローラーの項目ビュー、コンテキスト メニュー、リボン
  • [既定のプログラム] コントロール パネル
  • ファイル ピッカー
  • スタート画面での検索結果

ロゴがこれらの場所に表示されるように、プロジェクトに 44 x 44 のアイコンを含めます。 アプリのタイルのロゴの外観を調和させ、アイコンを透明にするのではなく、アプリの背景色を使います。 パディングせずにロゴを端まで拡張します。 アイコンは、白い背景でテストします。 アイコンについて詳しくは、「タイルとアイコン アセットのガイドライン」をご覧ください。

ステップ 3: アクティブ化イベントを処理する

OnFileActivated イベント ハンドラーは、すべてのファイル アクティブ化イベントを受け取ります。

Protected Overrides Sub OnFileActivated(ByVal args As Windows.ApplicationModel.Activation.FileActivatedEventArgs)
      ' TODO: Handle file activation
      ' The number of files received is args.Files.Size
      ' The name of the first file is args.Files(0).Name
End Sub
void App::OnFileActivated(Windows::ApplicationModel::Activation::FileActivatedEventArgs^ args)
{
       // TODO: Handle file activation
       // The number of files received is args->Files->Size
       // The first file is args->Files->GetAt(0)->Name
}
protected override void OnFileActivated(FileActivatedEventArgs args)
{
       // TODO: Handle file activation
       // The number of files received is args.Files.Size
       // The name of the first file is args.Files[0].Name
}

Note When launched via File Contract, make sure that Back button takes the user back to the screen that launched the app and not to the app's previous content.

新しいページを開くアクティブ化イベントごとにアプリで新しい XAML フレームを作成することをお勧めします。 こうすると、新しい XAML フレームのナビゲーション バックスタックに、中断されたときに現在のウィンドウに表示されていた以前のコンテンツが含まれなくなります。 起動コントラクトとファイル コントラクトで単一 XAML フレームを使うことにしたアプリは、新しいページに移動する前にフレームのナビゲーション ジャーナルにあるページをクリアする必要があります。

ファイル アクティブ化によって起動されたときは、アプリの先頭ページに戻ることができる UI を含めることを検討してください。

注釈

受け取るファイルは、信頼できないソースからのファイルである可能性があります。 操作する前に、ファイルのコンテンツを検証することをお勧めします。 入力の検証について詳しくは、安全なコードの記述をご覧ください。

この記事は、ユニバーサル Windows プラットフォーム (UWP) アプリを作成する Windows 10 開発者を対象としています。 Windows 8.x 用または Windows Phone 8.x 用の開発を行っている場合は、アーカイブされているドキュメントをご覧ください。

完全な例

概念

処理手順

ガイドライン

リファレンス