[アーティクル]
10/20/2021

Visual Studio 2010 自習書～ Do-It-Yourself シリーズ～
XAML による Windows アプリケーション開発の基礎

第 13 回ジャンプリスト

更新日: 2011 年 2 月 3 日

XAML Do-It-Yourself 第 13 回は、Windows 7 のジャンプリストにカスタムタスクを追加する方法について学習します。ジャンプリストは Windows 7 の新機能であり、タスクバー上のアイコンを右クリックすることで表示されます。WPF を使えば、ジャンプリストを簡単にカスタマイズできます。

今回は、次の 2 つを中心に学習します。

ジャンプリストにカスタムタスクを追加する
タスクから自分自身のアプリケーションを呼び出す

実際にジャンプリストを使用している様子を示します。ここで、ドキュメントカテゴリーと、タスクカテゴリーに項目が追加されています。

図 1

1. XAML を使ったジャンプリストの追加

WPF では、ジャンプリストを扱うために System.Windows.Shell 名前空間にある JumpList クラスを使います。アプリケーション全体で共通するジャンプリストは、アプリケーションオブジェクトを定義する XAML (App.xaml) を使って、次のように記述できます。

あらかじめユーザー\パブリック\パブリックのドキュメントフォルダーには Readme.txt を用意しておいてください。また、環境によっては、パスの設定を変更する必要があります。

プログラムを実行して、タスクバーでアイコンを右クリックすると次のように表示されます。

図 2
　

ページのトップへ

2. プログラムによるジャンプリストの追加

ジャンプリストを XAML で定義する方法では、あらかじめ決まったフォルダーやファイル名しか設定できません。自分自身を呼び出す場合も含め、実際に呼び出したいアプリケーションや作業フォルダーを確実に設定するには、プログラムでフォルダーやファイル名を割り当てる必要があります。

上記の App.xaml と同じように処理するため、Application クラスを継承した App クラスで OnStartup イベントハンドラーを次のように定義できます。

using System;
using System.Collections.Generic;
using System.Configuration;
using System.Data;
using System.Linq;
using System.Windows;
using System.Windows.Shell;
using System.Reflection;
using System.IO;

namespace WpfApplication13
{
/// <summary>
/// App.xaml の相互作用ロジック
/// </summary>
public partial class App : Application
{
    protected override void OnStartup(StartupEventArgs e)
    {
      JumpTask task = new JumpTask
      {
        Title = "Readme",
        Arguments = "Readme.txt",
        Description = "Readmeを開きます。",
        CustomCategory = "ドキュメント",
        IconResourcePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.System), "notepad.exe"),
        ApplicationPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.System), "notepad.exe"),
        WorkingDirectory = Environment.GetFolderPath(Environment.SpecialFolder.CommonDocuments),
      };

      JumpList list = new JumpList();
      list.JumpItems.Add(task);
      JumpList.SetJumpList(App.Current, list);
    }
}
}

自分自身のアプリケーションを呼び出す

ジャンプリストに登録するタスクは、自分自身のアプリケーションが処理したいことも多いでしょう。その際、どのような動作をさせるかをアプリケーションへの引数で指定することもできます。ここでは、メインウィンドウに引数で指定されたファイルを表示する機能を割り当ててみます。

まず、App クラスの OnStartup イベントハンドラーを次のように記述します。

public partial class App : Application
{
public static string DocToOpen = null;

protected override void OnStartup(StartupEventArgs e)
{
    if (e.Args.Count() > 0)
    {
      if (e.Args[0] == "/message")
      {
        MessageBox.Show("メッセージの表示");
        Shutdown();
      }

      // 引数をオープンするためのファイルとして保持
      DocToOpen = e.Args[0];
    }

    JumpTask task = new JumpTask
    {
      Title = "Readme",
      Arguments = "Readme.txt",
      Description = "Readme を開きます。",
      CustomCategory = "ドキュメント",
      IconResourcePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.System), "notepad.exe"),
      ApplicationPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.System), "notepad.exe"),
      WorkingDirectory = Environment.GetFolderPath(Environment.SpecialFolder.CommonDocuments),
    };

    JumpTask task2 = new JumpTask
    {
      Title = "メッセージ表示",
      Arguments = "/message",
      Description = "メッセージを表示します",
      CustomCategory = "タスク",
      IconResourcePath = Assembly.GetEntryAssembly().CodeBase,
      ApplicationPath = Assembly.GetEntryAssembly().CodeBase,
      WorkingDirectory = Environment.CurrentDirectory,
    };

    JumpTask task3 = new JumpTask
    {
      Title = "Test document",
      Arguments = "TextFile.txt",
      Description = "テスト用のテキストを開きます",
      CustomCategory = "タスク",
      IconResourcePath = Assembly.GetEntryAssembly().CodeBase,
      ApplicationPath = Assembly.GetEntryAssembly().CodeBase,
      WorkingDirectory = Environment.CurrentDirectory,
    };

    JumpList list = new JumpList();
    list.JumpItems.Add(task);
    list.JumpItems.Add(task2);
    list.JumpItems.Add(task3);
    JumpList.SetJumpList(App.Current, list);
}
}

まず、OnStartup イベントハンドラーの第 2 引数に渡される e を使い、アプリケーションの引数 (e.Args) を受け取ります。引数がある場合は、その引数が「/message」であれば、メッセージを表示するだけで終了し、そうでなければメインウィンドウでオープンするファイル名としてプロパティに設定します。

ジャンプリストには、「/message」という引数を渡すものと、「TextFile.txt」という引数を渡すものの 2 つのタスクを追加します。追加したタスクは、JumpTask オブジェクトの CustomCategory は指定した分類名ごとにまとめられてジャンプリストに表示されます。

引数としてオープンするファイル名が指定された場合、それをメインウィンドウに読み込むため、MainWindow.xaml は次のように記述します。

さらに、コードハインドとして次のようなイベントハンドラーを記述します。

private void Window_Loaded(object sender, RoutedEventArgs e)
{
StreamReader reader = new StreamReader(App.DocToOpen);
textBox1.Text = reader.ReadToEnd();
reader.Close();
}

TextFile.txt を読み込ませるためには、アプリケーションの作成先にこのファイルを置いておく必要があります。ソリューションエクスプローラーでプロジェクト名を右クリックし、[追加] - [新しい項目] を選んで、TextFile.txt という「テキストファイル」を追加してください。追加した TextFile.txt のプロパティは、ビルドアクションを「なし」に、出力ディレクトリにコピーを「新しい場合はコピーする」に設定します。

プログラムを実行した様子を示します。

図 3

ページのトップへ

3. まとめ

ジャンプリストは、Windows 7 の特徴的な機能の 1 つであり、WPF を使うことで容易に実装できます。ジャンプリストはアプリケーションクラスだけでなく、ウィンドウクラスにおいても追加することができます。すでにジャンプリストを構築している場合は、そのオブジェクトを使うか、JumpList.GetJumpList を使って設定されているジャンプリストを取り出して使ってください。

ページのトップへ

Visual Studio 2010 自習書～ Do-It-Yourself シリーズ～
XAML による Windows アプリケーション開発の基礎

第 13 回ジャンプリスト