Share via


ワークシート ホスト項目

Worksheet ホスト項目は、Excel のプライマリ相互運用機能アセンブリの Worksheet 型を拡張する型です。 Worksheet ホスト項目には、 Worksheet オブジェクトと同じプロパティ、メソッド、イベントがすべて用意されています。また、追加のイベントも公開し、ホスト コントロールおよび Windows フォーム コントロールのコンテナーとしても機能します。

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

ドキュメント レベルのプロジェクトでは、デザイン時に Worksheet ホスト項目をプロジェクトに追加できます。 VSTO アドイン プロジェクトでは、実行時に Worksheet ホスト項目を生成できます。

ドキュメントレベルのプロジェクトでのワークシートのホスト項目について

Excel のドキュメント レベルのプロジェクトを作成すると、Visual Studio によって 3 つの Worksheet ホスト項目がプロジェクト内に自動的に作成されます。 これらのワークシートの既定の名前は、 Sheet1Sheet2Sheet3です。 既存のブックに基づいてプロジェクトを作成する場合は、そのブック内のワークシートの数に応じてホスト項目の数が決まります。

これらのワークシート クラスによって、 Worksheet ホスト項目のメンバーにアクセスし、ワークシートのコンテンツを変更するなど、カスタマイズの基本的なタスクを実行できます。 また、ワークシートにコントロールを追加するには、これらのクラスを使用できます。 さまざまな種類のコントロールを組み合わせ、コードを記述すると、コントロールをデータにバインドしたり、ユーザーから情報を収集したり、ユーザーの操作に応答したりできます。 詳細については、「プログラムによるドキュメントレベルのカスタマイズ」を参照してください。

ワークシート クラスには、プロジェクトでコードの記述を開始できる場所が用意されています。 このクラスには、Excel のプライマリ相互運用機能アセンブリの Worksheet オブジェクトと同じプロパティ、メソッド、イベントがすべて用意されているため、これらのクラスを使用して Excel のオブジェクト モデルにアクセスすることもできます。 詳細については、「Excel オブジェクト モデルの概要」を参照してください。

ドキュメント レベルのプロジェクトの場合は、デザイナーで新しいワークシートをブックに追加すると、デザイン時に追加の Worksheet ホスト項目をプロジェクトに追加できます。

ワークシートの名前変更

ドキュメント レベルのプロジェクトでは、Visual Studio デザイナーでワークシートの名前を変更できますが、この場合はワークシートの表示名だけが変わります。 ワークシートのプログラム上の名前は既定の名前のままです。 [プロパティ] ウィンドウでワークシートの名前を変更すると、プログラム上の名前だけが変更されます。

ドキュメントレベルのプロジェクトでのワークシートのホスト項目の制限

ドキュメント レベルのプロジェクトでは、実行時に新しい Worksheet ホスト項目を作成することはできません。 実行時に新しい Excel ワークシートを作成すると、そのワークシートは Worksheet型になります。 これはホスト項目ではないため、ホスト コントロールや Windows フォーム コントロールを含めることはできません。 実行時にドキュメントを作成する方法の詳細については、「方法: プログラムを使用して新しいワークシートをブックに追加する」を参照してください。

VSTO アドイン プロジェクトでのワークシートのホスト項目について

アプリケーション レベルのプロジェクトでは、Excel で開いている任意のワークシートの Worksheet ホスト項目を実行時に生成できます。 Worksheet ホスト項目を使用して、関連付けられたワークシートにコントロールを追加したり、 Worksheet オブジェクトで使用できないイベントを処理したりできます。

Worksheet ホスト項目を生成するには、GetVstoObject メソッドを使用します。 詳細については、「実行時に VSTO アドインの Word 文書と Excel ブックを拡張する」を参照してください。