Office ソリューションのコードの記述
Office プロジェクトのコードの記述には、Visual Studio の他のプロジェクトの種類とは異なる点があります。相違点の多くは、Office オブジェクト モデルがマネージ コードに公開される方法に関連しています。Office プロジェクトのデザインに関連する相違点もあります。
対象: このトピックの情報は、Office 2013 および Office 2010 のドキュメント レベルのプロジェクトおよびアプリケーション レベルのプロジェクトに適用されます。詳細については、「Office アプリケーションおよびプロジェクト タイプ別の使用可能な機能」を参照してください。
マネージ コードおよび Office プログラミング
Microsoft Office 統合ソリューションの作成を実現するための鍵となるテクノロジは、コンポーネント オブジェクト モデル (COM: Component Object Model) テクノロジの一部であるオートメーションです。オートメーションにより、コードを使用して、適切なプログラミング インターフェイスで作成されたアプリケーション、DLL、または ActiveX コントロールによって公開されるソフトウェア オブジェクトを作成および制御できます。
.gif "Bb608596.collapse_all(ja-jp,VS.110).gif")
プライマリ相互運用機能アセンブリについて
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 ソリューションを開発できるようにコンピューターを構成する」を参照してください。
Office PIA は、エンド ユーザーのコンピューターに .NET Framework 4 か .NET Framework 4.5を対象とする Office ソリューションを実行する必要はありません。詳細については、「Office ソリューションのデザインと作成」を参照してください。
プライマリ相互運用機能アセンブリでの型の使用
Office PIA には、Office アプリケーションのオブジェクト モデルを公開する型とコード内で直接使用することを目的としていない追加のインフラストラクチャの型の組み合わせが含まれています。Office PIA の型の概要については、「Overview of Classes and Interfaces in the Office Primary Interop Assemblies」を参照してください。
Office PIA の型は COM ベース オブジェクト モデルの型に対応しているため、これらの型の使用方法は、他のマネージ型の使用方法とは異なる場合があります。たとえば、Office プライマリ相互運用機能アセンブリの省略可能なパラメーターを持つメソッドを呼び出す方法は、プロジェクトで使用するプログラミング言語によって異なります。詳細については、次のトピックを参照してください。
Office プロジェクトのプログラミング モデル
すべての Office プロジェクトには、コードのエントリ ポイントを提供する 1 つ以上のクラスが生成されます。これらのクラスを使用して、ホスト アプリケーションのオブジェクト モデルにアクセスしたり、操作ウィンドウやカスタム作業ウィンドウなどの機能にアクセスしたりできます。
生成されるクラスについて
Excel および Word のドキュメント レベル プロジェクトの場合、生成されるクラスは、アプリケーションのオブジェクト モデルのトップレベルのオブジェクトに似ています。たとえば、Word 文書プロジェクトに生成される ThisDocument クラスは、Word オブジェクト モデルの Microsoft.Office.Interop.Word.Document クラスと同じメンバーを提供します。ドキュメント レベルのプロジェクトで生成されるクラスの詳細については、「ドキュメント レベルのカスタマイズのプログラミング」を参照してください。
アプリケーション レベルのプロジェクトには、ThisAddIn というクラスが生成されます。このクラスは、ホスト アプリケーションのオブジェクト モデル内のクラスには似ていません。代わりに、このクラスはアドイン自体を表し、ホスト アプリケーションのオブジェクト モデルへのアクセスと、アドインで利用可能な他の機能へのアクセスに使用できるメンバーを提供します。詳細については、「アプリケーション レベルのアドインのプログラミング」を参照してください。
Office プロジェクトで生成されるすべてのクラスには、Startup および Shutdown のイベント ハンドラーが含まれます。コードを書き始めるには、通常はこれらのイベント ハンドラーにコードを追加します。アドインを初期化するには、コードを Startup イベント ハンドラーに追加します。アドインによって使用されるリソースをクリーンアップするには、コードを Shutdown イベント ハンドラーに追加します。詳細については、「Office プロジェクトのイベント」を参照してください。
生成されたクラスへの実行時のアクセス
Office ソリューションが読み込まれると、Visual Studio Tools for Office Runtime によって、プロジェクト内に生成された各クラスがインスタンス化されます。これらのオブジェクトには、プロジェクト内の任意のコードから Globals クラスを使用してアクセスできます。たとえば、Globals クラスを使用して、アプリケーション レベルのアドインのリボン ボタンのイベント ハンドラーから 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# よりコードが小さくなります。
と. Visual C# Office ソリューションの Visual Basic でのプログラミング
Office ソリューションは、Visual Basic と Visual C# のどちらを使用しても作成できます。Microsoft Office オブジェクト モデルは VBA (Microsoft Visual Basic for Applications) で使用するようにデザインされているので、Visual Basic 開発者は Microsoft Office アプリケーションで公開されているオブジェクトを容易に操作できます。Visual Studio 2012 では、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 を使用します。 |
参照
処理手順
方法 : プライマリ相互運用機能アセンブリを利用して Office アプリケーションを使用する
方法: Office プロジェクトでイベント ハンドラーを作成する