ブックホスト項目Workbook host item

Workbook ホスト項目は、Excel のプライマリ相互運用機能アセンブリの Workbook 型を拡張する型です。The Workbook host item is a type that extends the Workbook type from the primary interop assembly for Excel. Workbook ホスト項目は Workbook オブジェクトと同じプロパティ、メソッド、イベントがすべて用意されているだけなく、追加の機能も用意されています。The Workbook host item provides all of the same properties, methods, and events as a Workbook object, but it also provides additional features.

適用対象: このトピックの情報は、ドキュメントに適用されます-レベルのプロジェクトおよび 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.

ドキュメント レベルのプロジェクトには、プロジェクト内のブックを表す既定の Workbook ホスト項目があります。In document-level projects, there is a default Workbook host item that represents the workbook in your project. VSTO アドイン プロジェクトでは、実行時に Workbook ホスト項目を生成できます。In VSTO Add-in projects, you can generate Workbook host items at run time.

ドキュメントレベルのプロジェクトのブックホスト項目についてUnderstand the workbook host item in document-level projects

プロジェクトのブックにアクセスするには、 ThisWorkbook クラスを使用します。To access the workbook in your project, use the ThisWorkbook class. ThisWorkbook クラスによって、 Workbook ホスト項目のメンバーにアクセスし、ブックが開かれたり閉じられたりしたときにコードを実行するなど、カスタマイズの基本的なタスクを実行できます。The ThisWorkbook class gives you access to members of the Workbook host item to perform basic tasks in your customization, such as running code when the workbook is opened or closed. 詳細については、「プログラムによるドキュメントレベルのカスタマイズ」を参照してください。For more information, see Program document-level customizations.

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

[ソリューション エクスプローラー]ThisWorkbook プロジェクト項目をダブルクリックすると、ブックのデザイナーが表示され、 [プロパティ] ウィンドウにブックのプロパティとイベントが表示されます。Double-click the ThisWorkbook project item in Solution Explorer to display the workbook designer and to view the properties and events of the workbook in the Properties window.

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

ドキュメント レベルのプロジェクトには、1 つの Workbook ホスト項目のみ (つまり ThisWorkbook クラス) を含めることができます。A document-level project can contain only one Workbook host item (that is, the ThisWorkbook class). デザイン時に新しい Workbook ホスト項目をプロジェクトに追加することはできません。また、実行時にドキュメント レベルのカスタマイズから新しい Workbook ホスト項目を作成することもできません。You cannot add new Workbook host items to your project at design time, and you cannot create new Workbook host items at run time from a document-level customization.

実行時に新しい Excel ブックを作成すると、そのワークシートは Workbook型になります。If you create a new Excel workbook at run time, it will be of the type Workbook. これはホスト項目ではないため、ホスト コントロールや Windows フォーム コントロールを含めることはできません。Because it is not a host item, it cannot contain any host controls or Windows Forms controls. 実行時にブックを作成する方法の詳細については、「」を参照してください。プログラムによって新しいブックを作成します。For more information about creating workbooks at run time, see How to: Programmatically create new workbooks.

Workbook ホスト項目は、ホスト コントロールのコンテナーとしては機能しません。The Workbook host item does not act as a container for host controls. そのため、表示されるコントロールをブックに追加することはできませんが、 DataSetなどのコンポーネントを追加すると、すべてのワークシートでそのコンポーネントを共有できます。Therefore, you cannot add any visible controls to the workbook, but you can add components, such as a DataSet, so that the components can be shared by all worksheets. ドキュメント レベルのプロジェクトでは、ブックで使用できるコンポーネントは、 [ツールボックス][コンポーネント] タブ、 [データ] タブ、 [すべての Windows フォーム] タブに表示されます。In a document-level project, components available to the workbook can be found on the Component tab, Data tab, and All Windows Forms tab of the Toolbox.

Note

Visual Studio の Office 開発ツールでは、共有ブックはサポートされません。The Office development tools in Visual Studio do not support shared workbooks.

VSTO アドインプロジェクトでのブックホスト項目についてUnderstand workbook host items in VSTO Add-in projects

VSTO アドイン プロジェクトでは、Excel で開いている任意のブックの Workbook ホスト項目を実行時に生成できます。In VSTO Add-in projects, you can generate a Workbook host item at run time for any workbook that is open in Excel. Workbook ホスト項目を生成するには、GetVstoObject メソッドを使用します。To generate a Workbook host item, use the GetVstoObject method. 詳細については、「 VSTO アドインでの実行時の Word 文書と Excel ブックの拡張」を参照してください。For more information, see Extend Word documents and Excel workbooks in VSTO Add-ins at run time.

関連項目See also