|Important||This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.|
Workbook Class (2007 System)
Represents a workbook in Visual Studio Tools for Office projects for Microsoft Office Excel.
Assembly: Microsoft.Office.Tools.Excel.v9.0 (in Microsoft.Office.Tools.Excel.v9.0.dll)
The class is the base class for workbook host items in Visual Studio Tools for Office projects. The class provides the same members as the Workbook class in the Excel primary interop assembly, but it adds the following features:
VstoSmartTags property. Use this property to add smart tags to a workbook.
RemoveCustomization method. Use this method to remove the Visual Studio Tools for Office customization assembly from the workbook in a document-level customization.
CreateRibbonObjects method. Override this method if you added multiple custom Ribbons to your project by using the Ribbon (Visual Designer) item template, and you want to specify which Ribbons to display at run time.
GetAutomationObject method. Override this method to expose a class in your project to VBA code in the workbook.
Creating Workbook Host Items
In application-level projects created by using Visual Studio 2008 Service Pack 1 (SP1), you can create objects programmatically by using the GetVstoObject method of any Workbook object. For more information, see Extending Word Documents and Excel Workbooks in Application-Level Add-ins at Run Time.
In document-level projects, you cannot create a object programmatically. Instead, use the ThisWorkbook class to programmatically access the workbook in your project. Visual Studio generates this class in your project at design time. The ThisWorkbook class derives from the class, and it is instantiated automatically by the Visual Studio Tools for Office runtime when the end user opens the document. For more information, see Programming Document-Level Customizations.