Office ソリューションでコードを書く

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

Office プロジェクトのコードの記述には、Visual Studio の他のプロジェクトの種類とは異なる点があります。相違点の多くは、Office オブジェクトモデルがマネージドコードに公開される方法に関連しています。 Office プロジェクトのデザインに関連する相違点もあります。

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

マネージドコードおよび Office プログラミング

Microsoft Office 統合ソリューションの作成を実現するための鍵となるテクノロジは、コンポーネントオブジェクトモデル (COM: Component Object Model) テクノロジの一部であるオートメーションです。オートメーションにより、コードを使用して、適切なプログラミングインターフェイスで作成されたアプリケーション、DLL、または ActiveX コントロールによって公開されるソフトウェアオブジェクトを作成および制御できます。

プライマリ相互運用機能アセンブリについて

Microsoft Office アプリケーションの多くの機能は、オートメーション用に公開されています。ただし、マネージドコード (Visual Basic や C# など) を直接使用して Office アプリケーションを自動化することはできません。マネージドコードを使用して Office アプリケーションを自動化するには、Office プライマリ相互運用機能アセンブリ (PIA: Primary Interop Assembly) を使用する必要があります。プライマリ相互運用機能アセンブリにより、Office アプリケーションの COM ベースのオブジェクトモデルとマネージドコードとの相互運用を実行できるようになります。

すべての Microsoft Office アプリケーションに PIA があります。 Visual Studio で Office アプリケーションを作成すると、適切な PIA への参照が自動的にプロジェクトに追加されます。プロジェクトから他の Office アプリケーションの機能を自動化するには、適切な PIA への参照を手動で追加する必要があります。詳細については、「方法: プライマリ相互運用機能アセンブリを利用して Office アプリケーションを使用する」を参照してください。

デザイン時および実行時のプライマリ相互運用機能アセンブリの使用

ほとんどの開発タスクを実行するには、開発用コンピューターのグローバルアセンブリキャッシュに Office PIA をインストールし、登録する必要があります。詳細については、「Office ソリューションを開発できるようにコンピューターを構成する」を参照してください。

エンドユーザーのコンピューターで .NET Framework 4 以降を対象とした Office ソリューションを実行する場合には、Office PIA は必要ありません。詳細については、「Office ソリューションの設計と作成」を参照してください。

プライマリ相互運用機能アセンブリでの型の使用

Office PIA には、Office アプリケーションのオブジェクトモデルを公開する型とコード内で直接使用することを目的としていない追加のインフラストラクチャの型の組み合わせが含まれています。 Office PIA の型の概要については、「Office プライマリ相互運用機能アセンブリのクラスとインターフェイスの概要」を参照してください。

Office PIA の型は COM ベースオブジェクトモデルの型に対応しているため、これらの型の使用方法は、他のマネージド型の使用方法とは異なる場合があります。たとえば、Office プライマリ相互運用機能アセンブリの省略可能なパラメーターを持つメソッドを呼び出す方法は、プロジェクトで使用するプログラミング言語によって異なります。詳細については、次のトピックを参照してください。

Office プロジェクトのプログラムモデル

すべての Office プロジェクトには、コードのエントリポイントを提供する 1 つ以上のクラスが生成されます。これらのクラスを使用して、ホストアプリケーションのオブジェクトモデルにアクセスしたり、操作ウィンドウやカスタム作業ウィンドウなどの機能にアクセスしたりできます。

生成されるクラスについて

Excel および Word のドキュメントレベルプロジェクトの場合、生成されるクラスは、アプリケーションのオブジェクトモデルのトップレベルのオブジェクトに似ています。たとえば、Word 文書プロジェクトに生成される ThisDocument クラスは、Word オブジェクトモデルの Document クラスと同じメンバーを提供します。ドキュメントレベルのプロジェクトで生成されるクラスについて詳しくは、「ドキュメントレベルのカスタマイズのプログラミング」をご覧ください。

VSTO アドインプロジェクトには、 ThisAddInというクラスが生成されます。このクラスは、ホストアプリケーションのオブジェクトモデル内のクラスには似ていません。代わりに、このクラスは VSTO アドイン自体を表し、ホストアプリケーションのオブジェクトモデルへのアクセスと、VSTO アドインで利用可能な他の機能へのアクセスに使用できるメンバーを提供します。詳細については、「VSTO アドインのプログラミング」を参照してください。

Office プロジェクトで生成されるすべてのクラスには、 Startup および Shutdown のイベントハンドラーが含まれます。コードを書き始めるには、通常はこれらのイベントハンドラーにコードを追加します。 VSTO アドインを初期化するには、コードを Startup イベントハンドラーに追加します。 VSTO アドインによって使用されるリソースをクリーンアップするには、コードを Shutdown イベントハンドラーに追加します。詳細については、「Office プロジェクトのイベント」を参照してください。

生成されたクラスへの実行時のアクセス

Office ソリューションが読み込まれると、Visual Studio Tools for Office ランタイムによって、プロジェクト内に生成された各クラスがインスタンス化されます。これらのオブジェクトには、プロジェクト内の任意のコードから Globals クラスを使用してアクセスできます。たとえば、 Globals クラスを使用して、VSTO アドインのリボンボタンのイベントハンドラーから ThisAddIn クラスのコードを呼び出すことができます。

詳細については、「Office プロジェクト内のオブジェクトへのグローバルアクセス」を参照してください。

Office ソリューションの名前空間に関する考慮事項

Office プロジェクトを作成した後で、プロジェクトの 既定の名前空間 (Visual Basic では ルート名前空間 ) を変更することはできません。既定の名前空間は、プロジェクトの作成時に指定したプロジェクト名と常に一致します。プロジェクト名を変更しても、既定の名前空間は変更されません。プロジェクトでの既定の名前空間の詳細については、「[アプリケーション] ページ (プロジェクトデザイナー) (C#)」および「[アプリケーション] ページ (プロジェクトデザイナー) (Visual Basic)」を参照してください。

C# プロジェクトのホスト項目クラスの名前空間の変更

Visual C# Office プロジェクトの場合、ホスト項目クラス ( ThisAddIn、 ThisWorkbook、 ThisDocument などのクラス) は独自の名前空間を持ちます。既定では、プロジェクトのホスト項目の名前空間は、プロジェクトの作成時に指定したプロジェクト名と一致します。

Visual C# Office プロジェクトのホスト項目の名前空間を変更するには、 ホスト項目の名前空間 プロパティを使用します。詳細については、「Office プロジェクトのプロパティ」を参照してください。

Office プロジェクトでサポートされているプログラミング言語

Visual Studio の Office プロジェクトテンプレートは、プログラミング言語として Visual Basic と Visual C# のみサポートしています。したがって、これらのプロジェクトテンプレートは、Visual Studio の [新しいプロジェクト] ダイアログボックスの [Visual Basic] ノードと [Visual C#] ノードでのみ使用できます。詳細については、「方法: Visual Studio で Office プロジェクトを作成する」を参照してください。

言語の選択と Office プログラミング

Microsoft Office と Visual Basic for Applications (VBA) には、相互の連携によってアプリケーションのカスタマイズワークフローを最適化する機能が組み込まれています。そうした機能の一部は Visual Basic に引き継がれています。たとえば、Visual Basic は省略可能なパラメーターをサポートしているため、Microsoft Office プライマリ相互運用機能アセンブリのメソッドを呼び出す場合、Visual C# よりコードが小さくなります。

Office ソリューションでの Visual Basic と Visual C# を使用したプログラミング

Office ソリューションは、Visual Basic と Visual C# のどちらを使用しても作成できます。 Microsoft Office オブジェクトモデルは VBA (Microsoft Visual Basic for Applications) で使用するようにデザインされているので、Visual Basic 開発者は Microsoft Office アプリケーションで公開されているオブジェクトを容易に操作できます。 Visual C# 開発者は Visual Basic 開発者と同じ機能のほとんどを使用できますが、Office オブジェクトモデルを使用するには、追加のコードを記述することが必要な場合があります。また、Office 開発における基本的なプログラミング機能と Visual Basic や C# で記述されたマネージドコードとの間にもいくつかの違いがあります。

Visual Basic と Visual C# の主な相違点

次の表は、Office 開発で Visual Basic を使用する場合と Visual C# を使用する場合の主な相違点を示しています。

特徴量	説明	Visual Basic のサポート	Visual C# のサポート
オプションパラメーター	Microsoft Office のメソッドには、呼び出すときに指定する必要のないパラメーターを持つメソッドが多数あります。パラメーターの値を渡さない場合は、既定の値が使用されます。	Visual Basic では、省略可能なパラメーターをサポートしています。	Visual C# では、ほとんどの場合に省略可能なパラメーターをサポートしています。詳細については、「Office ソリューションでの省略可能なパラメーター」を参照してください。
パラメーターの参照渡し	大部分の Microsoft Office プライマリ相互運用機能アセンブリにある省略可能なパラメーターは、値によって引き渡すこと (値渡し) ができます。ただし、一部のプライマリ相互運用機能アセンブリでは、参照型を受け取る省略可能なパラメーターに対して参照渡しを行わなくてはなりません。値型と参照型のパラメーターの詳細については、「引数の値渡しと参照渡し (Visual Basic)」 (Visual Basic の場合) および「パラメーターの引き渡し (C# プログラミングガイド)」を参照してください。	参照渡しでパラメーターを渡すのに、特別な処理は必要ありません。 Visual Basic コンパイラでは、必要に応じて自動的にパラメーターが参照渡しされます。	ほとんどの場合、Visual C# コンパイラでは、必要に応じて自動的にパラメーターが参照渡しされます。詳細については、「Office ソリューションでの省略可能なパラメーター」を参照してください。
パラメーター化したプロパティ	プロパティの中には、パラメーターを受け取り、読み取り専用関数として動作するものがあります。	Visual Basic では、パラメーターを受け取るプロパティをサポートしています。	Visual C# では、パラメーターを受け取るプロパティをサポートしています。
遅延バインディング	遅延バインディングでは、デザイン時にオブジェクトの型に変数をキャストするのではなく、実行時にオブジェクトのプロパティを決定します。	Visual Basic では、 Option Strict がオフの場合に遅延バインディングが実行されます。 Option Strict がオンの場合は、オブジェクトを明示的に変換し、System.Reflection 名前空間内の型を使用して遅延バインディングメンバーにアクセスする必要があります。詳細については、「Office ソリューションの遅延バインディング」を参照してください。	Visual C# では、.NET Framework 4 を対象とするプロジェクトで遅延バインディングが実行されます。詳細については、「Office ソリューションの遅延バインディング」を参照してください。

Office 開発とマネージドコードの主な相違点

次の表は、Office 開発と Visual Basic または Visual C# で作成されたマネージドコードの主な相違点を示しています。

特徴量	説明	Visual Basic および Visual C# のサポート
配列のインデックス	Microsoft Office アプリケーションでは、コレクションの配列の下限のインデックスは 1 から始まります。 Visual Basic や Visual C# では、インデックス番号が 0 から始まる配列が使用されます。詳細については、「配列 (C# プログラミングガイド)」および「Visual Basic の配列」を参照してください。	Microsoft Office アプリケーションのオブジェクトモデルのコレクションの 1 番目のアイテムにアクセスするには、インデックス 0 ではなく 1 を使用します。