Worksheet ホスト項目Worksheet host item

Worksheet ホスト項目は、Excel のプライマリ相互運用機能アセンブリの Worksheet 型を拡張する型です。The Worksheet host item is a type that extends the Worksheet type from the primary interop assembly for Excel. Worksheet ホスト項目は Worksheet オブジェクトと同一のプロパティ、メソッド、イベントをすべて提供します。また、追加のイベントも公開し、ホスト コントロールおよび Windows フォーム コントロールのコンテナーとしても機能します。The Worksheet host item provides all of the same properties, methods, and events as a Worksheet object, but it also exposes additional events and acts as a container for host controls and Windows Forms controls.

適用対象: このトピックの情報は、ドキュメントに適用されます-レベルのプロジェクトおよび VSTO 追加-で Excel 用のプロジェクト。Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects for Excel. 詳細については、「Office アプリケーションおよびプロジェクトの種類で使用できる機能」を参照してください。For more information, see Features available by Office application and project type.

ドキュメント レベルのプロジェクトでは、デザイン時に Worksheet ホスト項目をプロジェクトに追加できます。In document-level projects, you can add Worksheet host items to your project at design time. VSTO アドイン プロジェクトで生成できるWorksheet実行時に項目をホストします。In VSTO Add-in projects, you can generate Worksheet host items at runtime.

ドキュメント レベルのプロジェクトのワークシート ホスト項目を理解します。Understand worksheet host items in document-level projects

Excel のドキュメント レベルのプロジェクトを作成すると、Visual Studio によって 3 つの Worksheet ホスト項目がプロジェクト内に自動的に作成されます。When you create a document-level project for Excel, Visual Studio automatically creates three Worksheet host items in the project. これらのワークシートの既定の名前は、 Sheet1Sheet2Sheet3です。The default names of the worksheets are Sheet1, Sheet2, and Sheet3. 既存のブックに基づいてプロジェクトを作成する場合は、そのブック内のワークシートの数に応じてホスト項目の数が決まります。If you create a project based on an existing workbook, the number of host items depends on the number of worksheets in the workbook.

これらのワークシート クラスによって、 Worksheet ホスト項目のメンバーにアクセスし、ワークシートのコンテンツを変更するなど、カスタマイズの基本的なタスクを実行できます。These worksheet classes give you access to members of the Worksheet host item to perform basic tasks in your customization, such as modifying the contents of a worksheet. また、ワークシートにコントロールを追加するには、これらのクラスを使用できます。You can also use these classes to add controls to worksheets. さまざまな種類のコントロールを組み合わせ、コードを記述することによって、コントロールのデータへのバインド、ユーザー情報の収集、およびユーザーの操作への応答を実行できます。By combining different sets of controls and writing code, you can bind the controls to data, collect information from the user, and respond to user actions. 詳細については、次を参照してください。ドキュメント レベルのカスタマイズのプログラミングします。For more information, see Program document-level customizations.

ワークシート クラスには、プロジェクトでコードの記述を開始できる場所が用意されています。The worksheet classes provide a location in which you can start writing code in your project. このクラスには、Excel のプライマリ相互運用機能アセンブリの Worksheet オブジェクトと同じプロパティ、メソッド、イベントがすべて用意されているため、これらのクラスを使用して Excel のオブジェクト モデルにアクセスすることもできます。Because the class provides all of the same properties, methods, and events as the Worksheet object in the primary interop assembly for Excel, you can also use these classes to access the object model of Excel. 詳細については、次の Excel オブジェクト モデルの概要を参照してください。For more information, see Excel object model overview.

ドキュメント レベルのプロジェクトの場合は、デザイナーで新しいワークシートをブックに追加すると、デザイン時に追加の Worksheet ホスト項目をプロジェクトに追加できます。In document-level projects, you can add additional Worksheet host items to the project at design time by adding a new worksheet to the workbook in the designer.

ワークシートの名前を変更します。Rename worksheets

ドキュメント レベルのプロジェクトでは、Visual Studio デザイナーでワークシートの名前を変更できますが、この場合はワークシートの表示名だけが変わります。In a document-level project, you can rename the worksheets in the Visual Studio designer, but this only changes the display name of the worksheet. ワークシートのプログラム上の名前は既定の名前のままです。The programmatic name is still the default name of the worksheet. [プロパティ] ウィンドウでワークシートの名前を変更すると、プログラム上の名前だけが変更されます。If you rename the worksheet in the Properties window, only the programmatic name is changed.

ドキュメント レベルのプロジェクトで、worksheet ホスト項目の制限事項Limitations of the worksheet host item in document-level projects

新規に作成することはできませんWorksheetドキュメント レベルのプロジェクトの実行時に項目をホストします。You cannot create new Worksheet host items at runtime in a document-level project. 実行時に新しい Excel ワークシートを作成する場合、型のことがWorksheetします。If you create a new Excel worksheet at runtime, it will be of the type Worksheet. これはホスト項目ではないため、ホスト コントロールや Windows フォーム コントロールを含めることはできません。Because it is not a host item, it cannot contain any host controls or Windows Forms controls. 実行時にドキュメントを作成する方法の詳細については、次を参照してください。方法。プログラムで新しいワークシートをブックに追加します。For more information about creating documents at run time, see How to: Programmatically add new worksheets to workbooks.

VSTO アドイン プロジェクトのワークシート ホスト項目を理解します。Understand worksheet host items in VSTO Add-in projects

アプリケーション レベルのプロジェクトでは、Excel で開いている任意のワークシートの Worksheet ホスト項目を実行時に生成できます。In application-level projects, you can generate a Worksheet host item at run time for any worksheet that is open in Excel. Worksheet ホスト項目を使用して、関連付けられたワークシートにコントロールを追加したり、 Worksheet オブジェクトで使用できないイベントを処理したりできます。You can use the Worksheet host item to add controls to the associated worksheet, or to handle events that are not available on Worksheet objects.

Worksheet ホスト項目を生成するには、GetVstoObject メソッドを使用します。To generate a Worksheet host item, use the GetVstoObject method. 詳細については、次を参照してください。拡張 Word 文書や Excel ブックを実行時に VSTO アドインでします。For more information, see Extend Word documents and Excel workbooks in VSTO Add-ins at runtime.

関連項目See also