アプリケーションレベルのアドインのプログラミング

[アーティクル]
08/09/2011

アプリケーションレベルのアドインを作成して Microsoft Office アプリケーションを拡張するときは、プロジェクトの ThisAddIn クラスに対して直接コードを記述します。このクラスを使用して、Microsoft Office ホストアプリケーションのオブジェクトモデルへのアクセス、アプリケーションのユーザーインターフェイス (UI) のカスタマイズ、アドイン内のオブジェクトの他の Office ソリューションへの公開などのタスクを実行できます。

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

アドインプロジェクトのコードの記述には、Visual Studio の他のプロジェクトの種類とは異なる点があります。相違点の多くは、Office オブジェクトモデルがマネージコードに公開される方法によって生じます。詳細については、「Office ソリューションのコードの記述」を参照してください。

アプリケーションレベルのアドインおよび Visual Studio の Office 開発ツールで作成できる他のソリューションの種類の概要については、「Office ソリューションの開発の概要」を参照してください。

ThisAddIn クラスの使用

アドインコードの記述は ThisAddIn クラスから開始できます。このクラスは、Visual Studio によって、アドインプロジェクト内の ThisAddIn.vb コードファイル (Visual Basic の場合) または ThisAddIn.cs コードファイル (C# の場合) に自動的に生成されます。 Microsoft Office アプリケーションがアドインを読み込むと、Visual Studio Tools for Office Runtime によってこのクラスが自動的にインスタンス化されます。

ThisAddIn クラスには、既定のイベントハンドラーが 2 つあります。アドインが読み込まれるときにコードを実行するには、ThisAddIn_Startup イベントハンドラーにコードを追加します。アドインがアンロードされる直前にコードを実行するには、ThisAddIn_Shutdown イベントハンドラーにコードを追加します。これらのイベントハンドラーの詳細については、「Office プロジェクトのイベント」を参照してください。

注意

Outlook 2010 の場合、既定では、アドインがアンロードされるときに、ThisAddIn_Shutdown イベントハンドラーが常に呼び出されるわけではありません。詳細については、「Office プロジェクトのイベント」を参照してください。

ホストアプリケーションのオブジェクトモデルへのアクセス

ホストアプリケーションのオブジェクトモデルにアクセスするには、ThisAddIn クラスの Application フィールドを使用します。このフィールドは、ホストアプリケーションの現在のインスタンスを表すオブジェクトを返します。各アドインプロジェクトの Application フィールドについて、戻り値の型の一覧を、次の表に示します。

ホストアプリケーション	戻り値の型
Microsoft Office Excel	Microsoft.Office.Interop.Excel.Application
Microsoft Office InfoPath	Microsoft.Office.Interop.InfoPath.Application
Microsoft Office Outlook	Microsoft.Office.Interop.Outlook.Application
Microsoft Office PowerPoint	Microsoft.Office.Interop.PowerPoint.Application
Microsoft Office Project	Microsoft.Office.Interop.MSProject.Application
Microsoft Office Visio	Microsoft.Office.Interop.Visio.Application
Microsoft Office Word	Microsoft.Office.Interop.Word.Application

Application フィールドを使用して Microsoft Office Excel のアドインに新しいブックを作成する方法を、次のコード例に示します。このコード例は ThisAddIn クラスから実行することを前提としています。

Dim newWorkbook As Excel.Workbook = Me.Application.Workbooks.Add()

Excel.Workbook newWorkbook = this.Application.Workbooks.Add(System.Type.Missing);

同じ操作を ThisAddIn クラスの外側から実行するには、Globals オブジェクトを使用して ThisAddIn クラスにアクセスします。 Globals オブジェクトの詳細については、「Office プロジェクト内のオブジェクトへのグローバルアクセス」を参照してください。

Dim newWorkbook As Excel.Workbook = Globals.ThisAddIn.Application.Workbooks.Add()

Excel.Workbook newWorkbook = Globals.ThisAddIn.Application.Workbooks.Add(System.Type.Missing);

特定の Microsoft Office アプリケーションのオブジェクトモデルの詳細については、以下のトピックを参照してください。

他のタスクで使用する ThisAddIn のメンバー

次の表では、他の一般的なタスクについて説明し、それらのタスクの実行に使用できる ThisAddIn クラスのメンバーを示します。

タスク	使用するメンバー
読み込まれたアドインを初期化するコードを実行します。	コードを ThisAddIn_Startup メソッドに追加します。これが Startup イベントの既定のイベントハンドラーです。詳細については、「Office プロジェクトのイベント」を参照してください。
アドインのアンロード前にアドインが使用したリソースをクリーンアップするコードを実行します。	コードを ThisAddIn_Shutdown メソッドに追加します。これが Shutdown イベントの既定のイベントハンドラーです。詳細については、「Office プロジェクトのイベント」を参照してください。メモ Outlook 2010 の場合、既定では、アドインがアンロードされるときに、ThisAddIn_Startup イベントハンドラーが常に呼び出されるわけではありません。詳細については、Office プロジェクトのイベントを参照してください。
カスタム作業ウィンドウを表示します。	CustomTaskPanes フィールドを使用します。詳細については、「カスタム作業ウィンドウの概要」を参照してください。
開いている Word 文書または Excel ブックで識別できるスマートタグを作成します。メモスマートタグは、Excel 2010 および Word 2010 では使用されていません。詳細については、「スマートタグの概要」を参照してください。	Excel または Word 用のアドインで VstoSmartTags フィールドを使用します。詳細については、「スマートタグの概要」を参照してください。
アドインのオブジェクトを他の Microsoft Office ソリューションに公開します。	RequestComAddInAutomationService メソッドをオーバーライドします。詳細については、「他の Office ソリューションからのアプリケーションレベルのアドインのコードの呼び出し」を参照してください。
機能拡張インターフェイスを実装して Microsoft Office system の機能をカスタマイズします。	RequestService メソッドをオーバーライドし、インターフェイスを実装するクラスのインスタンスを返します。詳細については、「機能拡張インターフェイスによる UI 機能のカスタマイズ」を参照してください。メモリボン UI をカスタマイズするために、CreateRibbonExtensibilityObject メソッドをオーバーライドすることもできます。

ThisAddIn クラスのデザインについて

.NET Framework 3.5 を対象とするプロジェクトでは、ThisAddIn クラスは Visual Studio Tools for Office Runtime の Microsoft.Office.Tools.AddIn クラスから派生します。

.NET Framework 4 を対象とするプロジェクトでは、Microsoft.Office.Tools.AddIn はインターフェイスであるため、生成された ThisAddIn クラスでは実装を派生できません。代わりに、ThisAddIn クラスは Microsoft.Office.Tools.AddInBase から派生します。この基本クラスでは、メンバーへのすべての呼び出しは Visual Studio Tools for Office Runtime の Microsoft.Office.Tools.AddIn インターフェイスの内部実装にリダイレクトされます。 .NET Framework 3.5 および .NET Framework 4 を対象とするプロジェクトでの Visual Studio Tools for Office Runtime の相違点の詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。

Outlook のアドインプロジェクトでは、ThisAddIn クラスは Microsoft.Office.Tools.Outlook.OutlookAddIn クラス (.NET Framework 3.5 を対象とするプロジェクトの場合) および Microsoft.Office.Tools.Outlook.OutlookAddInBase クラス (.NET Framework 4 を対象とするプロジェクトの場合) から派生します。これらの基本クラスにはフォーム領域をサポートする追加機能が用意されています。フォーム領域の詳細については、「Outlook フォーム領域の作成」を参照してください。

Microsoft Office アプリケーションのユーザーインターフェイスのカスタマイズ

アプリケーションレベルのアドインを使用すると、Microsoft Office アプリケーションの UI をプログラムでカスタマイズできます。たとえば、リボンのカスタマイズ、カスタム作業ウィンドウの表示、Outlook でのカスタムフォーム領域の作成などを行うことができます。詳細については、「Office UI のカスタマイズ」を参照してください。

Visual Studio には、カスタム作業ウィンドウの作成、リボンのカスタマイズ、および Outlook フォーム領域の作成に使用できる、デザイナーとクラスが用意されています。これらのデザイナーとクラスは、機能のカスタマイズプロセスを簡略化するのに役立ちます。詳細については、「カスタム作業ウィンドウの概要」、「リボンデザイナー」、および「Outlook フォーム領域の作成」を参照してください。

クラスやデザイナーではサポートされていない方法でこれらの機能をカスタマイズする場合、アドインに機能拡張インターフェイスを実装することで、それを実現できます。詳細については、「機能拡張インターフェイスによる UI 機能のカスタマイズ」を参照してください。

文書およびブックの動作を拡張するホスト項目を生成して、Word 文書および Excel ブックの UI を変更することもできます。これにより、マネージコントロールおよびスマートタグを文書とワークシートに追加することができます。詳細については、「アプリケーションレベルのアドインにおける実行時の Word 文書や Excel ブックの拡張」を参照してください。

他のソリューションからのアプリケーションレベルのアドインのコードの呼び出し

アドインのオブジェクトを Office ソリューションなどの他のソリューションに公開できます。これは、作成したアドインから、他のソリューションで使用できるサービスを提供する場合に役立ちます。たとえば、Web サービスの財務データについて計算する Microsoft Office Excel のアドインがある場合、実行時に Excel アドインを呼び出すことによって、他のソリューションがこれらの計算を実行できるようになります。

詳細については、「他の Office ソリューションからのアプリケーションレベルのアドインのコードの呼び出し」を参照してください。