Outlook 2010 ソリューションモジュールのプログラミング

[アーティクル]
09/24/2014

**概要:**Microsoft Office Outlook 2007 では、フォルダーをプログラムによって作成し、ナビゲーションウィンドウ上でそのフォルダーに移動することができました。ただし、そのフォルダーにはメール、予定表 (会議出席依頼と予定を含む)、連絡先、タスク、履歴、メモなど、組み込みの Outlook アイテムが含まれている必要がありました。Microsoft Outlook 2010 では、ソリューションモジュールを使用して、カスタムの種類のアイテムが含まれるフォルダーにも移動できます。ここでは、ソリューションモジュールの概要を説明し、ソリューションモジュールを使用して解決できる問題の例を提示し、ソリューションモジュールを実装する具体的な方法を示すサンプルアドインを提供します。

適用対象: Office 2010 | Outlook 2010

この記事の内容
概要
Outlook のナビゲーションモジュール
何が問題なのか
ソリューションモジュールのプログラミング
サンプルアドイン
その他の注意事項
まとめ
その他の技術情報

概要
Outlook のナビゲーションモジュール
何が問題なのか
ソリューションモジュールのプログラミング
サンプルアドイン
その他の注意事項
まとめ
その他の技術情報

概要

長年の間、Outlook のナビゲーションウィンドウにカスタムモジュールを追加する機能は、開発者から要望されていました。Microsoft Outlook 2010 では、この機能がソリューションモジュールオブジェクトモデルによって提供されます。ソリューションモジュールは、プログラムによってナビゲーションウィンドウに追加できるナビゲーションモジュールです。実のところ、ソリューションモジュールを追加する手段はコード以外にありません。ユーザーインターフェイスを使用してソリューションモジュールを作成することはできません。ソリューションモジュールは、フォルダー階層を検索したり、カスタマイズしたアイテムの種類をフォルダーに保存したりすることができる強力な機能です。たとえば、顧客関係管理 (CRM) アプリケーションでは、取引先担当者、取引先企業、営業案件など、カスタムのアイテムの種類をソリューションモジュールとして公開できます。また、アドインの開発者は、Outlook 2010 を使用して、カスタムのアイテムの種類を含むフォルダーごとにカスタムのフォルダーアイコンを設定できます。図 1 は、ソリューションモジュールのサンプルである "Solution Demo" を示しています。

図 1. Outlook 2010 のソリューションモジュールの例

Outlook 2010 のサンプルソリューションモジュール

Outlook のナビゲーションモジュール

Outlook 2007 は、固有のカスタムフォルダーを備えたソリューションをビルドできる多機能のモデルをサポートしています。これらのフォルダーには、メール、予定表アイテム、連絡先、タスクなど、組み込みの Outlook アイテムの種類を格納できます。既存のナビゲーションモジュールを使用して、カスタムフォルダーに簡単に移動できます。組み込みの Outlook アイテムの種類に一致するナビゲーションモジュールの例を以下に示します。

[連絡先] および [フォルダー一覧] ナビゲーションモジュールは、連絡先アイテムの種類が格納された、次のようなフォルダーを表示できます。
- 人事グループ用のフォルダー。たとえば、面接予定者の一覧をこのフォルダーに格納し、応募者に閲覧を許可できます。
- 営業グループ用のフォルダー。たとえば、見込み客の一覧をこのフォルダーに格納し、営業担当者に閲覧を許可できます。
[予定表] および [フォルダー一覧] ナビゲーションモジュールは、予定表アイテムの種類が格納された、次のようなフォルダーを表示できます。
- 人事グループ用のフォルダー。たとえば、面接の予定をこのフォルダーに格納できます。
- 営業グループ用のフォルダー。たとえば、アカウントプランニングの重要な日程をこのフォルダーに格納できます。
[タスク] および [フォルダー一覧] ナビゲーションモジュールは、タスクアイテムの種類が格納されたフォルダーを表示できます。たとえば、人事グループ用のフォルダーには、応募者のグループが共有できる面接の情報を格納できます。
[ショートカット] ナビゲーションモジュールは、異なる種類のフォルダーを 1 つのグループとして表示できます。たとえば、人事グループ用のショートカットモジュールは、次の種類のフォルダーをまとめて表示できます。
- 面接予定者の連絡先。
- 面接スケジュール用の予定表アイテム。
- 採用活動に関するタスク。

図 2 は、異なるナビゲーションモジュールの相互関係を表すベン図です。

図 2. Outlook 2007 のナビゲーションモジュール

Outlook 2007 のナビゲーションモジュール

何が問題なのか

開発者が組み込みの Outlook アイテムのいずれの種類にも合致しない新しい構造向けにフォルダーを作成し、エンドユーザーのシナリオとアクティビティをサポートするためにそれらを Outlook に表示しようとすると、問題が発生します。このようなフォルダーに移動する直観的な方法を提供できません。たとえば、このようなフォルダーには以下のアイテムが格納されると仮定します。

営業グループ用の営業案件の一覧。
人事グループ用の人材募集の一覧。
マーケティンググループ用のマーケティングキャンペーンの一覧。

エンドユーザーは、これらのデータの一覧を既存のナビゲーションモジュール ([フォルダー一覧] を除く) で表示できるとは思いません。開発者は Outlook 2010 のソリューションモジュールを使用して、以下の機能を提供してこの問題を解決できます。

新しいソリューションモジュールを使用して、メール、予定表、連絡先、タスク、メモ、または履歴のいずれのナビゲーションモジュールにも属さないフォルダーを表示します。
この新しいカスタムの種類のアイテム用にルートフォルダーと、そのルートフォルダーを整理する際に使用するソリューションモジュール名を指定します。開発者は、SolutionsModule オブジェクトの AddSolution メソッドを使用して、ソリューションモジュールに追加されるソリューションに対応するルートフォルダーを指定できます。AddSolution メソッドの Scope パラメーターを OlSolutionScope.olHideInDefaultModules に設定すると、指定したフォルダーはこの新しい種類として、新しいソリューションモジュールとフォルダー一覧にのみ表示されます。Scope パラメーターを OlSolutionScope.olShowInDefaultModules に設定すると、フォルダーは既存のモジュール、フォルダー一覧、およびソリューションモジュールに表示されます。

図 3 は、Outlook 2010 にソリューションモジュールを追加して更新したベン図です (Scope を olHideInDefaultModules に設定した場合)。

図 3. Outlook 2010 のソリューションとナビゲーションモジュール

Outlook 2010 のソリューションとナビゲーションモジュール

ソリューションモジュールのプログラミング

ソリューションモジュールをナビゲーションウィンドウに表示するには、アドインで以下の操作を行う必要があります。

SolutionsModule オブジェクトのインスタンスを作成します。
SolutionsModule オブジェクトの AddSolution メソッドを呼び出し、ソリューションルートフォルダーを表す Folder オブジェクトを渡します。これ以降は、ソリューションルートフォルダーの下にあるすべてのフォルダーがソリューション モジュールに追加されます。OlSolutionScope 列挙は、ソリューションルートフォルダーとそのサブフォルダーをナビゲーションウィンドウ内の既定のモジュールに表示するかどうかを指定します。
必要であれば、SolutionsModule オブジェクトの Position プロパティを設定して、ソリューション モジュールのボタンがナビゲーションウィンドウに大きなボタンで表示されるようにします。

サンプルアドイン

この記事には、SolutionsModuleAddinCS という名前のサンプルアドインが付属します。このアドインは Microsoft Visual C# を使用し、実行には Microsoft Visual Studio 2008 Service Pack 1 と Outlook 2010 を必要とします。

インストール手順

サンプルアドインをインストールするには、次の手順に従います。

SolutionsModuleAddinCS.zip ファイルを MSDN Code Gallery (英語) Web サイトからダウンロードします。
.zip ファイルを任意のフォルダーに展開します。Windows Vista では、Visual Studio 2008 プロジェクトの既定のパスは、 C:\Users\user\Documents\Visual Studio 2008\Projects です。

SolutionsModuleAddinCS を実行するには、次の手順に従います。

Outlook を閉じます。
SolutionsModuleAddinCS.zip ファイルを展開したフォルダーで、SolutionsModuleAddinCS ソリューションを開きます。
[ビルド] メニューの [SolutionsModuleAddinCS のビルド] をクリックします。
Outlook を起動して、このアドインを実行モードで起動するか、F5 キーを押してデバッグモードで起動します。Outlook がデバッグモードで起動しない場合は、以下の手順を実行します。

デバッグモードで Outlook を起動するには

ソリューションエクスプローラーで、[SolutionsModuleAddinCS] を選択します。
[プロジェクト] メニューの [SolutionsModuleAddinCS のプロパティ] をクリックし、次に [デバッグ] タブをクリックします。
[開始動作] の [外部プログラムの開始] オプションを選択し、[参照] をクリックします。
[ドライブ:]\Program Files\Microsoft Office\Office14 フォルダーで Outlook.exe をクリックします。
F5 キーを押して、デバッグモードでアドインを開始します。

コードウォークスルー

SolutionsModuleAddinCS のコードは簡潔であり、そのスコープは制限されています。唯一の目的はソリューションモジュールをプログラムによって有効にすることであり、ボーナス機能としてソリューションモジュール用のフォルダーアイコンをカスタマイズすることができます。このサンプルコードには EnsureSolutionsModule という 1 つのメソッドがあり、ThisAddin クラスの Startup メソッドからこれが呼び出されます。ソリューションモジュールアドインの Startup メソッドは、一般に Outlook の起動時に実行され、Outlook の最初の実行時やそれ以降の起動時にソリューションが表示されるようにします。

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    // Call EnsureSolutionsModule to ensure that the
    // Solutions module and the custom folder icons
    // appear in the Outlook Navigation Pane.
    EnsureSolutionsModule(); 
}

ソリューションをソリューションモジュールに追加する前に、ソリューションモジュールに表示するフォルダー階層を十分に検討して設計してください。ソリューションのルートフォルダーはソリューションルートフォルダーと呼ばれ、エンドユーザーがソリューションを簡単に識別できる名前にする必要があります。1 つのソリューションだけをソリューションモジュールにインストールした場合は、そのソリューションルートフォルダーの名前がソリューションモジュールのボタンのラベルになります。1 つ以上のソリューションをインストールした場合は、ソリューションモジュールのボタンのラベルは [ソリューション] に戻り、ソリューションモジュールの各ソリューションルートフォルダーの名前がヒントに表示されます。

EnsureSolutionsModule メソッドでは、ソリューションルートフォルダーを "Solution Demo" と名付けています。この名前のフォルダーが存在しない場合、rootStoreFolder インスタンス変数が表す既定のストアにこのフォルダーが作成されます。Solution Calendar などの名前でさらにソリューションフォルダーを追加すると、それらは Solution Demo のサブフォルダーとして作成されます。ソリューションルートフォルダーのすべてのサブフォルダーは、そのソリューションルートフォルダーの子である必要があります。異なるストア内のフォルダーを含むソリューションルートフォルダーや、別のソリューションルートフォルダーの子であるソリューションルートフォルダーを追加することはできません。ソリューションルートフォルダーは、個人用フォルダーファイル (.pst) またはカスタムストアプロバイダーに格納できます。その場合は, .pst 内またはカスタムストア内のソリューションルートフォルダーを表す Folder オブジェクトを取得してください。以下に、EnsureSolutionsModule メソッドの該当部分のコードを示します。

bool firstRun = false ;
Outlook.Folder rootStoreFolder =
    Application.Session.DefaultStore.GetRootFolder()
    as Outlook.Folder;
// If the solution root folder does not exist, create it.
// Note that the solution root 
// could also be in a PST or custom store.
try
{
    solutionRoot =
        rootStoreFolder.Folders["Solution Demo"]
        as Outlook.Folder;
}
catch
{
    firstRun = true;
}

Solution Demo フォルダーが存在しない場合は firstRun 変数を true に設定し、それ以外の場合は false に設定します。どちらの場合も、solutionCalendar、solutionContacts など、インスタンス変数をソリューションルートフォルダー内の各サブフォルダーを指すように設定します。これらのインスタンス変数は、各ソリューションサブフォルダーとソリューションルートフォルダーのカスタムフォルダーアイコンを設定するために使用します。

Folder オブジェクトの SetCustomIcon メソッドを使用して、フォルダーにカスタムフォルダーアイコンを設定できます。このカスタムフォルダーアイコンは永続化されないので、アドインが読み込まれるたびに設定する必要があります。また、16 x 16 ピクセルの大きさのアイコンリソースを持つアイコンを IPictureDisp オブジェクトとして設定する必要があります。IPictureDisp オブジェクトをプロセス境界を越えて渡すことはできないので、Outlook のプロセス内で実行されているアドインから SetCustomIcon を呼び出す必要があります。Outlook のプロセス外で実行されているアプリケーションから呼び出した場合、SetCustomIcon はエラーを生成します。アドインプロジェクトに定義された PictureDispConverter クラスは、アイコンリソースを IPictureDisp オブジェクトに変換します。このクラスは、この記事のソリューションモジュールシナリオとは直接関係ないので、ここでは説明しません。

すべてのフォルダーアイコンを設定した後で、次のコードを使用して、solutionsModule という名前のインスタンス変数を取得します。

// Obtain a reference to the SolutionsModule object.
Outlook.Explorer explorer = Application.ActiveExplorer();
Outlook.SolutionsModule solutionsModule =
    explorer.NavigationPane.Modules.GetNavigationModule(
    Outlook.OlNavigationModuleType.olModuleSolutions)
    as Outlook.SolutionsModule;

Modules オブジェクトの GetNavigationModule メソッドは、olModuleSolutions をモジュールの種類として指定すると、SolutionsModule オブジェクトを返します。次に AddSolution メソッドを呼び出して、ソリューションルートフォルダーを表す Folder オブジェクトとソリューションルートフォルダーとそのサブフォルダーを既定のナビゲーションウィンドウモジュール (メール、予定表、連絡先、タスクなど) に表示するかどうかを決定する OlSolutionScope 値を渡します。OlSolutionScope が olHideInDefaultModules であれば、ソリューションルートフォルダーとそのサブフォルダーは、ソリューションモジュールとフォルダー一覧モジュールのみに表示されます。OlSolutionScope が olShowInDefaultModules であれば、ソリューションルートフォルダーとそのサブフォルダーは、ソリューションモジュール、フォルダー一覧モジュール、およびフォルダーの種類に応じて適切な既定のモジュールに表示されます。たとえば、予定表アイテムの種類のフォルダーは、OlSolutionScope が olShowInDefaultModules である場合に、予定表モジュールにも表示されます。

特定のフォルダーはソリューションルートフォルダーとして無効であり、そのようなフォルダーを指定して AddSolution メソッドを呼び出すとエラーになります。PST ストアまたはカスタムストアのルートフォルダーであるフォルダーが有効なソリューションルートフォルダーであることに注意してください。次のフォルダーは、有効なソリューションルートフォルダーです。

既定のフォルダーまたは特別なフォルダー。既定のフォルダーは OlDefaultFolders 列挙で表され、特別なフォルダーは OlSpecialFolders 列挙で表されます。
別のソリューションのソリューションルートフォルダーに既になっているフォルダー。
既存のソリューションルートフォルダーのサブフォルダーであるフォルダー。
既存のソリューションルートフォルダーの親フォルダーであるフォルダー。

次のコード例では、AddSolution メソッドを呼び出して、ソリューションモジュールとフォルダー一覧モジュールのみに表示されるソリューションルートフォルダーを指定します。

// Add the solution and hide folders in default modules.
solutionsModule.AddSolution(solutionRoot,
    Outlook.OlSolutionScope.olHideInDefaultModules);

最後に、ナビゲーションウィンドウに表示するソリューションモジュールボタンの位置とサイズを制御します。SolutionsModule オブジェクトの Visible、Position、および DisplayedModuleCount プロパティを使用して、ソリューションモジュールのボタンの表示と非表示、位置、およびサイズを指定します。DisplayedModuleCount が SolutionsModule オブジェクトの Position プロパティよりも小さい場合は、モジュールボタンは大きなボタンではなく小さなボタンで表示されます。

// The following code sets the position and visibility
// of the Solutions module.
if (solutionsModule.Visible == false)
{
    // Set Visibile to true.
    solutionsModule.Visible = true;
}
if (solutionsModule.Position != 5)
{
    // Move SolutionsModule to Position = 5.
    solutionsModule.Position = 5;
}
// Create an instance variable for the Navigation Pane.
Outlook.NavigationPane navPane = explorer.NavigationPane;
if (navPane.DisplayedModuleCount != 5)
{
    // Ensure that the Solutions module button is large.
    navPane.DisplayedModuleCount = 5;
}

EnsureSolutionsModule メソッドの全体を詳しく調べる必要がある場合のために、以下にこのメソッドの完全なコードリストを示します。

private void EnsureSolutionsModule()
{
    try
    {
        // Declarations.
        Outlook.Folder solutionRoot;
        Outlook.Folder solutionCalendar;
        Outlook.Folder solutionContacts;
        Outlook.Folder solutionTasks;
        bool firstRun = false ;
        Outlook.Folder rootStoreFolder =
            Application.Session.DefaultStore.GetRootFolder()
            as Outlook.Folder;
        // If the solution root folder does not exist, create it.
        // Note that the solution root 
        // could also be in a PST or custom store.
        try
        {
            solutionRoot =
                rootStoreFolder.Folders["Solution Demo"]
                as Outlook.Folder;
        }
        catch
        {
            firstRun = true;
        }

        if (firstRun == true)
        {
            solutionRoot =
                rootStoreFolder.Folders.Add("Solution Demo",
                Outlook.OlDefaultFolders.olFolderInbox) 
                as Outlook.Folder;
            solutionCalendar = solutionRoot.Folders.Add(
                "Solution Calendar", 
                Outlook.OlDefaultFolders.olFolderCalendar)
                as Outlook.Folder;
            solutionContacts = solutionRoot.Folders.Add(
                "Solution Contacts", 
                Outlook.OlDefaultFolders.olFolderContacts)
                as Outlook.Folder;
            solutionTasks = solutionRoot.Folders.Add(
                "Solution Tasks", 
                Outlook.OlDefaultFolders.olFolderTasks)
                as Outlook.Folder;
        }
        else
        {
            solutionRoot =
                rootStoreFolder.Folders["Solution Demo"]
                as Outlook.Folder;
            solutionCalendar = solutionRoot.Folders[
                "Solution Calendar"]
                as Outlook.Folder;
            solutionContacts = solutionRoot.Folders[
                "Solution Contacts"]
                as Outlook.Folder;
            solutionTasks = solutionRoot.Folders[
                "Solution Tasks"]
                as Outlook.Folder;
        } 
        // Get the icons for the solution.
        stdole.StdPicture rootPict = 
            PictureDispConverter.ToIPictureDisp(
            Properties.Resources.BRIDGE)
            as stdole.StdPicture;
        stdole.StdPicture calPict = 
            PictureDispConverter.ToIPictureDisp(
            Properties.Resources.umbrella)
            as stdole.StdPicture;
        stdole.StdPicture contactsPict = 
            PictureDispConverter.ToIPictureDisp(
            Properties.Resources.group)
            as stdole.StdPicture;
        stdole.StdPicture tasksPict = 
            PictureDispConverter.ToIPictureDisp(
            Properties.Resources.SUN)
            as stdole.StdPicture;
        // Set the icons for the solution folders.
        solutionRoot.SetCustomIcon(rootPict);
        solutionCalendar.SetCustomIcon(calPict);
        solutionContacts.SetCustomIcon(contactsPict);
        solutionTasks.SetCustomIcon(tasksPict);
        // Obtain a reference to the Solutions module.
        Outlook.Explorer explorer = Application.ActiveExplorer();
        solutionsModule =
            explorer.NavigationPane.Modules.GetNavigationModule(
            Outlook.OlNavigationModuleType.olModuleSolutions)
            as Outlook.SolutionsModule;
        // Add the solution and hide folders in default modules.
        solutionsModule.AddSolution(solutionRoot, 
            Outlook.OlSolutionScope.olHideInDefaultModules);
        // The following code sets the position and visibility
        // of the Solutions module.
        if (solutionsModule.Visible == false)
        {
            // Set Visibile to true
            solutionsModule.Visible = true;
        }
        if (solutionsModule.Position != 5)
        {
            // Move SolutionsModule to Position = 5
            solutionsModule.Position = 5;
        }
        // Create an instance variable for the Navigation Pane.
        Outlook.NavigationPane navPane = explorer.NavigationPane;
        if (navPane.DisplayedModuleCount != 5)
        {
            // Ensure that the Solutions module button is large.
            navPane.DisplayedModuleCount = 5;
        }
    }
    catch (Exception ex)
    {
        Debug.Write(ex.Message);
    }
}

その他の注意事項

アプリケーションの開発時にソリューションモジュールを設計する際には、以下に示すソリューションモジュールのその他の特性についても注意してください。

AddSolution メソッドを呼び出すときに Scope パラメーターに olShowInDefaultModules を指定した場合は、メールアイテムが含まれるソリューションフォルダーをメールモジュールの [お気に入りのフォルダー] の一覧に追加できます。[お気に入りのフォルダー] の一覧に追加できるのは、メールフォルダーだけです。
エンドユーザーがソリューションモジュールに移動し、ソリューションモジュール内のソリューションフォルダーを現在のフォルダーにした場合、いったん別の場所に移動してから再びソリューションモジュールに移動すると、このフォルダーに戻ります。ただし、ソリューションモジュールの現在のフォルダー設定は、Outlook セッション間で維持されません。

まとめ

ソリューションモジュールは、Outlook 2010 のユーザーインターフェイスの重要な要素を開発者に提供します。Outlook では 1 つのソリューションモジュールだけですべてのソリューションをサポートしますが、開発者はソリューションモジュールを使用して、Outlook の以前のバージョンでは不可能だった方法で独自のソリューションを Outlook のナビゲーションウィンドウにシームレスに統合できます。

その他の技術情報

詳細については、次のリソースを参照してください。

次の方法で共有

Outlook 2010 ソリューションモジュールのプログラミング

概要

Outlook のナビゲーションモジュール

何が問題なのか

ソリューションモジュールのプログラミング

サンプルアドイン

インストール手順

コードウォークスルー

その他の注意事項

まとめ

その他の技術情報

その他のリソース

次の方法で共有

Outlook 2010 ソリューション モジュールのプログラミング

概要

Outlook のナビゲーション モジュール

何が問題なのか

ソリューション モジュールのプログラミング

サンプル アドイン

インストール手順

コード ウォークスルー

その他の注意事項

まとめ

その他の技術情報

その他のリソース

Outlook 2010 ソリューションモジュールのプログラミング

Outlook のナビゲーションモジュール

ソリューションモジュールのプログラミング

サンプルアドイン

コードウォークスルー