チュートリアル: 初めての Outlook 用 VSTO アドインを作成する

[アーティクル]
06/19/2023

このチュートリアルでは、Microsoft Office Outlook 用の VSTO アドインを作成する方法について説明します。この種のソリューションに作成した機能は、どの Outlook 項目が開いているかにかかわらず、アプリケーション自体に対して使用できます。詳細については、「Office ソリューションの開発の概要 (VSTO)」を参照してください。

適用対象: このトピックの情報は、Outlook の VSTO アドインプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクトの種類別の使用可能な機能」を参照してください。

Note

複数のプラットフォームで Office エクスペリエンスを拡張するソリューションの開発に関心がありますか。新しい Office アドインモデルを確認してください。 Office アドインの占有領域は、VSTO アドインやソリューションと比較して小さく、その作成には、HTML5、JavaScript、CSS3、XML など、ほぼすべての Web プログラミングテクノロジを使用できます。

このチュートリアルでは、次の作業について説明します。

Outlook 用の Outlook VSTO アドインプロジェクトを作成する。
Outlook のオブジェクトモデルを使用して、新しいメールメッセージの件名と本文にテキストを追加するコードを記述する。
プロジェクトをビルドし、実行してテストする。
完成したプロジェクトをクリーンアップして、開発用コンピューターでこの VSTO アドインが自動的に実行されないようにする。

Note

次の手順で参照している Visual Studio ユーザーインターフェイス要素の一部は、お使いのコンピューターでは名前や場所が異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio IDE のカスタマイズ」を参照してください。

必須コンポーネント

このチュートリアルを実行するには、次のコンポーネントが必要です。

Microsoft Office Developer Tools が含まれている Visual Studio のエディション。詳細については、「Office ソリューションを開発できるようにコンピューターを構成する」を参照してください。
Microsoft Outlook

プロジェクトを作成する

Visual Studio で新しい Outlook プロジェクトを作成するには

Visual Studio を起動します。
[ファイル] メニューの [新規作成] をポイントし、 [プロジェクト] をクリックします。
テンプレートペインで、 [Visual C#] または [Visual Basic]を展開してから、 [Office/SharePoint]を展開します。
展開した [Office/SharePoint] ノードの下で、 [Office Add-ins] ノードを選択します。
プロジェクトテンプレートの一覧で、Outlook VSTO アドインプロジェクトを選びます。
[名前] ボックスに、「 FirstOutlookAddIn」と入力します。
OK をクリックします。

Visual Studio により FirstOutlookAddIn プロジェクトが作成され、ThisAddIn コードファイルがエディターで開かれます。

新しい各メールメッセージにテキストを追加するコードを記述する

次に、ThisAddIn コードファイルにコードを追加します。この新しいコードでは、Outlook のオブジェクトモデルを使用して、それぞれの新しいメールメッセージにテキストを追加します。 ThisAddIn コードファイルには、次の生成コードが既定で含まれています。

ThisAddIn クラスの部分定義。このクラスは、コードのエントリポイントを提供し、Outlook のオブジェクトモデルへのアクセスを提供します。詳しくは、「VSTO アドインのプログラミング」をご覧ください。ThisAddIn クラスの残りの部分は、変更することができない非表示のコードファイルに定義されています。
ThisAddIn_Startup および ThisAddIn_Shutdown イベントハンドラー。これらのイベントハンドラーは、Outlook が VSTO アドインを読み込むときとアンロードするときに呼び出されます。これらのイベントハンドラーを使用して、VSTO アドインを読み込むときに初期化し、VSTO アドインがアンロードされるときには使用したリソースをクリーンアップします。詳細については、「Office プロジェクトのイベント」を参照してください。

新しい各メールメッセージの件名と本文にテキストを追加するには

ThisAddIn コードファイルで、 inspectors クラスに ThisAddIn というフィールドを宣言します。 inspectors フィールドは、Outlook の現在のインスタンスに含まれるインスペクターウィンドウのコレクションへの参照を保持します。この参照によって、 NewInspector イベントのイベントハンドラーが格納されたメモリをガベージコレクターが解放することを防止できます。
- C#
- VB
```
Outlook.Inspectors inspectors;
```
```
Private WithEvents inspectors As Outlook.Inspectors
```

ThisAddIn_Startup メソッドを次のコードに置き換えます。このコードは NewInspector イベントにイベントハンドラーをアタッチします。

private void ThisAddIn_Startup(object sender, System.EventArgs e)
{
    inspectors = this.Application.Inspectors;
    inspectors.NewInspector +=
    new Microsoft.Office.Interop.Outlook.InspectorsEvents_NewInspectorEventHandler(Inspectors_NewInspector);
}

Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
    inspectors = Me.Application.Inspectors
End Sub

ThisAddIn コードファイルで、次のコードを ThisAddIn クラスに追加します。このコードは、 NewInspector イベントのイベントハンドラーを定義します。

ユーザーが新しいメールメッセージを作成すると、このイベントハンドラーにより、メッセージの件名と本文にテキストが追加されます。

void Inspectors_NewInspector(Microsoft.Office.Interop.Outlook.Inspector Inspector)
{
    Outlook.MailItem mailItem = Inspector.CurrentItem as Outlook.MailItem;
    if (mailItem != null)
    {
        if (mailItem.EntryID == null)
        {
            mailItem.Subject = "This text was added by using code";
            mailItem.Body = "This text was added by using code";
        }

    }
}

Private Sub inspectors_NewInspector(ByVal Inspector As Microsoft.Office.Interop.Outlook.Inspector) Handles inspectors.NewInspector
    Dim mailItem As Outlook.MailItem = TryCast(Inspector.CurrentItem, Outlook.MailItem)
    If Not (mailItem Is Nothing) Then
        If mailItem.EntryID Is Nothing Then
            mailItem.Subject = "This text was added by using code"
            mailItem.Body = "This text was added by using code"
        End If
    End If
End Sub

新しい各メールメッセージを変更するために、前のコード例では次のオブジェクトを使用しています。

Application クラスの ThisAddIn フィールド。 Application フィールドは Outlook の現在のインスタンスを表す Application オブジェクトを返します。
Inspector イベントのイベントハンドラーの NewInspector パラメーター。 Inspector パラメーターは、新しいメールメッセージのインスペクターウィンドウを表す Inspector オブジェクトです。詳細については、「Outlook ソリューション」を参照してください。

プロジェクトをテストする

プロジェクトをビルドして実行し、新しいメールメッセージの件名と本文にテキストが表示されることを確認します。

プロジェクトをテストするには

F5 キーを押して、プロジェクトをビルドおよび実行します。

プロジェクトをビルドすると、プロジェクトのビルド出力フォルダーに含まれるアセンブリにコードがコンパイルされます。さらに Visual Studio は、Outlook が VSTO アドインを検出して読み込めるようにする一連のレジストリエントリを作成し、VSTO アドインを実行できるように開発用コンピューター上のセキュリティを設定します。詳細については、「Office ソリューションビルド処理の概要」を参照してください。
Outlook で、新しいメールメッセージを作成します。
メッセージの件名の行と本文の両方に、次のテキストが追加されることを確認します。

This text was added by using code.
Outlook を閉じます。

プロジェクトをクリーンアップする

プロジェクトの開発が完了したら、VSTO アドインアセンブリ、レジストリエントリ、およびセキュリティ設定を開発用コンピューターから削除します。そうしない場合、開発用コンピューターで Outlook を起動するたびに VSTO アドインが実行されます。

プロジェクトをクリーンアップするには

Visual Studio で、 [ビルド] メニューの [ソリューションのクリーン]をクリックします。

次のステップ

これで Outlook 用の基本的な VSTO アドインが作成されました。VSTO アドインの詳しい開発方法について、以下のトピックをご覧ください。

Outlook 用 VSTO アドインで実行できる一般的なプログラミングタスク。詳細については、「VSTO アドインのプログラミング」を参照してください。
Outlook のオブジェクトモデルの使用。詳細については、「Outlook ソリューション」を参照してください。
Outlook のユーザーインターフェイス (UI) のカスタマイズ (リボンへのカスタムタブの追加や独自のカスタム作業ウィンドウの作成など)。詳細については、「Office UI のカスタマイズ」を参照してください。
Outlook 用 VSTO アドインのビルドとデバッグ。詳細については、「Office ソリューションのビルド」を参照してください。
Outlook 用 VSTO アドインの配置。詳細については、「Office ソリューションを配置する」を参照してください。