アプリケーションレベルのアドインのアーキテクチャ

[アーティクル]
02/21/2013

Visual Studio の Office 開発ツールを使用して作成するアドインには、信頼性とセキュリティの向上に役立つアーキテクチャ要素があり、それらを Microsoft Office と緊密に連携させることができます。このトピックでは、アドインの以下の点について説明します。

アドインについて
アドインのコンポーネント
アドインと Microsoft Office アプリケーションの連携

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

アドインの作成の概要については、「Office ソリューションの開発の概要」および「アプリケーションレベルのアドインのプログラミングについて」を参照してください。

アドインについて

Visual Studio の Office 開発ツールを使用してアドインを作成するときには、Microsoft Office アプリケーションが読み込むマネージコードアセンブリを作成します。アセンブリが読み込まれると、アドインがアプリケーションで発生するイベント (ユーザーがメニュー項目をクリックした場合など) に応答できます。アドインでは、オブジェクトモデルを呼び出してアプリケーションの自動化や拡張を行うこともでき、さらに .NET Framework のクラスも使用できます。

アセンブリは、アプリケーションのプライマリ相互運用機能アセンブリを介してアプリケーションの COM コンポーネントとの通信を行います。詳細については、「Office プライマリ相互運用機能アセンブリ」および「Office ソリューションの開発の概要」を参照してください。

複数のアドインがアプリケーションにインストールされている場合、各アドインは異なるアプリケーションドメインに読み込まれます。このため、1 つのアドインが正しく動作しない場合でも、それが原因で他のアドインにエラーが発生することはありません。また、アプリケーションが閉じている場合には、すべてのアドインアセンブリがメモリから確実にアンロードされます。アプリケーションドメインの詳細については、「アプリケーションドメイン」を参照してください。

[!メモ]

Visual Studio の Office 開発ツールを使用して作成するアドインは、エンドユーザーがホスト Microsoft Office アプリケーションを起動したときにのみ使用されることを目的としています。アプリケーションがプログラムで起動された場合 (オートメーション機能を使用する場合など)、アドインは予期したとおりに動作しないことがあります。

アドインのコンポーネント

アドインのメインコンポーネントはアドインアセンブリですが、Microsoft Office アプリケーションがアドインを検出して読み込むときに重要な役割を果たすコンポーネントが他にもいくつかあります。

レジストリエントリ

Microsoft Office アプリケーションは、一連のレジストリエントリを検索してアドインを検出します。アドインで使用されるレジストリエントリの完全な一覧については、「アプリケーションレベルのアドインのレジストリエントリ」を参照してください。

ソリューションをビルドすると、Visual Studio によって開発コンピューター上に必要なレジストリエントリが作成されるので、アドインを簡単にデバッグおよび実行できます。詳細については、「Office ソリューションのビルド」を参照してください。

ClickOnce を使用してソリューションを配置すると、発行プロセスで生成されたセットアッププログラムによってエンドユーザーのコンピューター上にレジストリキーが自動的に作成されます。詳細については、「ClickOnce を使用した Office ソリューションの配置」を参照してください。

配置マニフェストとアプリケーションマニフェスト

アドインは、配置マニフェストとアプリケーションマニフェストを使用して、最新バージョンのアドインアセンブリを特定し、読み込みます。配置マニフェストは、最新のアプリケーションマニフェストを指します。アプリケーションマニフェストは、アドインアセンブリを指し、エントリポイントクラスを指定して、アセンブリ内で実行します。詳細については、「Office ソリューションにおけるアプリケーションマニフェストと配置マニフェスト」を参照してください。

Visual Studio Tools for Office ランタイム

アドインを実行するには、Visual Studio の Office 開発ツールを使用して作成された、コンピューターが Visual Studio Tools for Office Runtime があるエンドユーザーがインストールされます。ランタイムは、マネージアセンブリがのアンマネージコンポーネントと一連含まれます。アンマネージコンポーネントは、アドインアセンブリを読み込みます。これらのマネージアセンブリにより、アドインコードがホストアプリケーションを自動化して拡張するために使用するオブジェクトモデルが提供されます。

詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。

アドインと Microsoft Office アプリケーションの連携

ユーザーが Microsoft Office アプリケーションを起動すると、アプリケーションは配置マニフェストとアプリケーションマニフェストを使用してアドインアセンブリの最新バージョンを検出し、読み込みます。アドインの基本アーキテクチャを次の図に示します。

アドインアーキテクチャ

2007 Office アドインアーキテクチャ

[!メモ]

.NET Framework 4 か .NET Framework 4.5を対象とする Office ソリューションでは、ソリューションアセンブリに埋め込まれた PIA を直接呼び出す代わりに、PIA の型情報を使用してホストアプリケーションのオブジェクトモデルへのソリューションを呼び出します。詳細については、「Office ソリューションのデザインと作成」を参照してください。

読み込みプロセス

ユーザーがアプリケーションを起動すると、次の処理が行われます。

アプリケーションは、Visual Studio の Office 開発ツールを使用して作成されたアドインを特定するレジストリエントリをチェックします。
該当するレジストリエントリが見つかると、アプリケーションは VSTOEE.dll を読み込み、VSTOEE.dll が VSTOLoader.dll を読み込みます。これらは、Office ランタイムの Visual Studio 2010 Tools のローダーコンポーネントのアンマネージ DLL です。詳細については、「Visual Studio Tools for Office Runtime の概要」を参照してください。
VSTOLoader.dll は .NET Framework を読み込み、Visual Studio Tools for Office Runtime のマネージ部分を起動します。
Visual Studio Tools for Office Runtime は、マニフェストの更新プログラムをチェックし、最新のアプリケーションマニフェストおよび配置マニフェストをダウンロードします。
Visual Studio Tools for Office Runtimeは、一連のセキュリティチェックを実行します。詳細については、「Office ソリューションのセキュリティ保護」を参照してください。
アドインを信頼して実行できる場合、Visual Studio Tools for Office Runtime は配置マニフェストとアプリケーションマニフェストを使用して、アセンブリの更新をチェックします。利用できる新しいバージョンのアセンブリが存在する場合、ランタイムは、クライアントコンピューターの ClickOnce キャッシュに新しいバージョンのアセンブリをダウンロードします。詳細については、「Office ソリューションの配置」を参照してください。
Visual Studio Tools for Office Runtime がアドインアセンブリの読み込み先となる新しいアプリケーションドメインを作成します。
Visual Studio Tools for Office Runtime がそのアプリケーションドメインにアドインアセンブリを読み込みます。
Visual Studio Tools for Office Runtime がアドインの RequestComAddInAutomationService メソッドを呼び出します (このメソッドをオーバーライドしている場合)。

このメソッドをオーバーライドして、アドイン内のオブジェクトを他の Microsoft Office ソリューションに公開することもできます。詳細については、「他の Office ソリューションからのアプリケーションレベルのアドインのコードの呼び出し」を参照してください。
Visual Studio Tools for Office Runtime がアドインの RequestService メソッドを呼び出します (このメソッドをオーバーライドしている場合)。

このメソッドをオーバーライドして、機能拡張インターフェイスを実装するオブジェクトを返すことにより、Microsoft Office 機能を拡張することもできます。詳細については、「機能拡張インターフェイスによる UI 機能のカスタマイズ」を参照してください。

[!メモ]

Visual Studio Tools for Office Runtime が、ホストアプリケーションによってサポートされる機能拡張インターフェイスごとに RequestService メソッドを呼び出します。RequestService メソッドの最初の呼び出しは、通常は ThisAddIn_Startup の呼び出しの前に行われますが、アドインでは RequestService メソッドが呼び出される時点や回数を推測することはできません。
Visual Studio Tools for Office Runtime がアドイン内の ThisAddIn_Startup メソッドを呼び出します。このメソッドは、Startup イベントの既定のイベントハンドラーです。詳細については、「Office プロジェクトのイベント」を参照してください。