WorkbookBase Class

Definition

Namespace:

Microsoft.Office.Tools.Excel

Assembly:

Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Provides the base class for the ThisWorkbook class in document-level projects for Microsoft Office Excel.

public ref class WorkbookBase abstract : IDisposable, Microsoft::Office::Tools::Excel::IWorkbookExtension, System::ComponentModel::IComponent, System::ComponentModel::ISupportInitialize, System::Windows::Forms::IBindableComponent

[System.ComponentModel.ToolboxItem(false)]
public abstract class WorkbookBase : IDisposable, Microsoft.Office.Tools.Excel.IWorkbookExtension, System.ComponentModel.IComponent, System.ComponentModel.ISupportInitialize, System.Windows.Forms.IBindableComponent

[<System.ComponentModel.ToolboxItem(false)>]
type WorkbookBase = class
    interface IWorkbookExtension
    interface IExtension
    interface EntryPoint
    interface ISupportInitialize
    interface IBindableComponent
    interface IComponent
    interface IDisposable

Public MustInherit Class WorkbookBase
Implements IBindableComponent, IComponent, IDisposable, ISupportInitialize, IWorkbookExtension

Inheritance

Object

WorkbookBase

Attributes

ToolboxItemAttribute

Implements

EntryPoint IWorkbookExtension IExtension IComponent ISupportInitialize IDisposable IBindableComponent

Examples

Host Items and Host Controls Overview

Workbook Host Item

Remarks

The WorkbookBase class is the base class for the ThisWorkbook class in document-level Excel projects created by using Visual Studio. Use the ThisWorkbook class to programmatically access the workbook in your project. For more information, see Programming Document-Level Customizations.

The WorkbookBase class provides the same members as the Microsoft.Office.Interop.Excel.Workbook object in the Excel primary interop assembly, but it adds the following features:

• VstoSmartTags property. Use this property to add smart tags to a workbook.

• InnerObject property. Use this property to get the underlying Microsoft.Office.Interop.Excel.Workbook object for a workbook host item.

• RemoveCustomization method. Use this method to remove the 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

You cannot create WorkbookBase objects programmatically in Office projects.

In document-level projects, the ThisWorkbook class (which derives from WorkbookBase) is instantiated automatically by the Visual Studio Tools for Office runtime when the end user opens the workbook. For more information, see Programming Document-Level Customizations.

In application-level projects, you can create workbook host items programmatically by using the GetVstoObject method. For more information, see Extending Word Documents and Excel Workbooks in VSTO Add-ins at Run Time.

Usage

This type is used only in Office projects that target the .NET Framework 4 or later. The assembly that defines this type is not part of the Visual Studio Tools for Office runtime. You must deploy this assembly with your solution. For more information, see Assemblies in the Visual Studio Tools for Office Runtime.

Constructors

WorkbookBase(Factory, IServiceProvider, String, String)

Properties

AccuracyVersion	Specifies whether certain worksheet functions use the latest accuracy algorithms to calculate their results.
ActiveChart	Gets a Chart object that represents the active chart (either an embedded chart or a chart sheet). An embedded chart is considered active when it is either selected or activated. When no chart is active, this property returns null.
ActiveSheet	Gets the active sheet (the sheet on top).
ActiveSlicer	Gets an object that represents the active slicer in the active workbook or in the specified workbook.
Application	Gets an Application that represents the creator of the workbook.
AutoUpdateFrequency	Gets or sets the number of minutes between automatic updates to the shared workbook.
AutoUpdateSaveChanges	Gets or sets a value that indicates whether current changes to the shared workbook are posted to other users whenever the workbook is automatically updated.
Base	Gets the Workbook object that this WorkbookBase object extends.
BindingContext
BuiltinDocumentProperties	Gets a Microsoft.Office.Core.DocumentProperties collection that represents all the built-in document properties for the workbook.
CalculationVersion	Gets a number that indicates the version of Excel that the workbook was last fully recalculated by. The rightmost four digits are the minor calculation engine version number, and the other digits (on the left) are the major version of Microsoft Office Excel.
ChangeHistoryDuration	Gets or sets the number of days shown in the shared workbook's change history.
Charts	Gets a Sheets collection that represents all the chart sheets in the workbook.
CheckCompatibility	Gets or sets a value that indicates whether to run the compatibility checker automatically when the workbook is saved.
Colors	Gets or sets colors in the palette for the workbook.
CommandBars	Gets a Microsoft.Office.Core.CommandBars object that represents the Microsoft Office Excel command bars.
ConflictResolution	Gets or sets the way conflicts are to be resolved whenever a shared workbook is updated.
Connections	Gets the collection of connections between the workbook and a data source.
ConnectionsDisabled	Gets a value that indicates whether to disable the external connections or links in the workbook.
Container	Gets the object that represents the container application for the workbook.
ContentTypeProperties	Gets a collection of properties that describe metadata that is stored in the workbook.
CreateBackup	Gets a value that indicates whether a backup file is created when this file is saved.
Creator	Gets the application in which the workbook was created.
CustomDocumentProperties	Gets a Microsoft.Office.Core.DocumentProperties collection that represents all the custom document properties for the workbook.
CustomViews	Gets a CustomViews collection that represents all the custom views for the workbook.
CustomXMLParts	Gets the collection of custom XML parts in the workbook.
DataBindings
DataHost
Date1904	Gets or sets a value that indicates whether the workbook uses the 1904 date system.
DefaultPivotTableStyle	Gets or sets the table style from the TableStyles property that is used as the default style for PivotTable reports in the workbook.
DefaultSlicerStyle
DefaultTableStyle	Gets or sets the table style from the TableStyles property that is used as the default style for tables in the workbook.
DisplayDrawingObjects	Gets or sets how shapes are displayed.
DisplayInkComments	Gets or sets a value that indicates whether ink comments are displayed in the workbook.
DocumentInspectors	Gets the collection of Document Inspector modules for the workbook.
DocumentLibraryVersions	Gets a Microsoft.Office.Core.DocumentLibraryVersions collection that represents the collection of versions of a shared workbook that has versioning enabled and that is stored in a document library on a server.
DoNotPromptForConvert	Gets or sets a value that indicates whether to prompt the user to convert the workbook if it contains features that are not supported by versions of Excel earlier than Excel 2007.
EnableAutoRecover	Gets or sets a value that indicates whether Microsoft Office Excel saves changed files, of all formats, on a timed interval.
EncryptionProvider	Gets the name of the algorithm encryption provider that Microsoft Office Excel uses when encrypting passwords for the workbook.
EnvelopeVisible	Gets or sets a value that indicates whether the e-mail composition header and the envelope toolbar are both visible.
Excel4IntlMacroSheets	Gets a Sheets collection that represents all the Microsoft Office Excel 4.0 international macro sheets in the workbook.
Excel4MacroSheets	Gets a Sheets collection that represents all the Microsoft Office Excel 4.0 macro sheets in the workbook.
Excel8CompatibilityMode	Gets a value that indicates whether the workbook is in compatibility mode.
FileFormat	Gets the file format and type of the workbook.
Final	Gets or sets a value that indicates whether the workbook is final.
ForceFullCalculation	Gets or sets a value that indicates whether to force a full calculation of a workbook.
FullName	Gets the name of the object, including its path on disk.
FullNameURLEncoded	Gets the name of the object, including its path on disk.
HasPassword	Gets a value that indicates whether the workbook has a protection password.
HasVBProject	Gets a value that indicates whether a workbook has an attached Microsoft Visual Basic for Applications (VBA) project.
HighlightChangesOnScreen	Gets or sets a value that indicates whether changes to the shared workbook are highlighted on screen.
HostContext
IconSets	Gets the collection of built-in icon sets that can be used to apply a conditional formatting rule to a range in the workbook.
InactiveListBorderVisible	Gets or sets a value that indicates whether list borders are visible when a list is not active.
InnerObject	Gets a Workbook that represents the underlying native object for the WorkbookBase.
IsAddin	Gets or sets a value that indicates whether the workbook is running as an add-in.
IsInplace	Gets a value that indicates whether the specified workbook is being edited in place
ItemProvider
KeepChangeHistory	Gets or sets a value that indicates whether change tracking is enabled for the shared workbook.
ListChangesOnNewSheet	Gets or sets a value that indicates whether changes to the shared workbook are shown on a separate worksheet.
Mailer
MultiUserEditing	Gets a value that indicates whether the workbook is open as a shared list.
Name	Gets the name of the workbook.
Names	Gets a Names collection that represents all the names in the workbook (including all worksheet-specific names).
Parent	Gets the parent object for the workbook.
Password	Gets or sets the password that must be supplied to open the workbook.
PasswordEncryptionAlgorithm	Gets the algorithm that Microsoft Office Excel uses to encrypt passwords for the workbook.
PasswordEncryptionFileProperties	Gets a value that indicates whether Microsoft Office Excel encrypts file properties for the specified password-protected workbook.
PasswordEncryptionKeyLength	Gets the key length of the algorithm that Microsoft Office Excel uses when encrypting passwords for the workbook.
PasswordEncryptionProvider	Gets the name of the algorithm encryption provider that Microsoft Office Excel uses when encrypting passwords for the workbook.
Path	Gets the complete path to the application, excluding the final separator and name of the application.
Permission	Gets a Microsoft.Office.Core.Permission object that represents the permission settings in the workbook.
PersonalViewListSettings	Gets or sets a value that indicates whether filter and sort settings for lists are included in the user's personal view of the shared workbook.
PersonalViewPrintSettings	Gets or sets a value that indicates whether print settings are included in the user's personal view of the shared workbook.
PrecisionAsDisplayed	Gets or sets a value that indicates whether calculations in this workbook will be done using only the precision of the numbers as they are displayed.
ProtectStructure	Gets a value that indicates whether the order of the sheets in the workbook is protected.
ProtectWindows	Gets a value that indicates whether the windows of the workbook are protected.
PublishObjects	Gets the PublishObjects collection.
ReadOnly	Gets a value that indicates whether the workbook has been opened as read-only.
ReadOnlyRecommended	Gets or sets a value that indicates whether the workbook was saved as read-only recommended.
RemovePersonalInformation	Gets or sets a value that indicates whether personal information can be removed from the workbook.
Research	Gets an object that represents the research service for the workbook.
RevisionNumber	Gets the number of times the workbook has been saved while open as a shared list. If the workbook is open in exclusive mode, this property returns 0 (zero).
Saved	Gets or sets a value that indicates whether no changes have been made to the workbook since it was last saved.
SaveLinkValues	Gets or sets a value that indicates whether Microsoft Office Excel saves external link values with the workbook.
ServerPolicy	Gets an object that represents a policy specified for a workbook that is stored on a server running Microsoft Office SharePoint Server.
ServerViewableItems	Gets an object that you can use to interact with the list of published objects in the workbook that are shown on a Microsoft Office SharePoint Server server.
SharedWorkspace	Gets a Microsoft.Office.Core.SharedWorkspace that represents the Document Workspace in which the workbook is located.
Sheets	Gets a Sheets collection that represents all the sheets in the workbook.
ShowConflictHistory	Gets or sets a value that indicates whether the Conflict History worksheet is visible in the workbook that is open as a shared list.
ShowPivotChartActiveFields	Gets or sets a value that indicates whether the PivotChart Filter Pane is visible.
ShowPivotTableFieldList	Gets or sets a value that indicates whether the PivotTable field list can be shown.
Signatures	Gets the collection of digital signatures for the workbook.
Site
SlicerCaches	Gets the SlicerCaches object associated with the workbook.
SmartDocument	Gets a Microsoft.Office.Core.SmartDocument that represents the settings for a smart document solution.
Styles	Gets a Styles collection that represents all the styles in the workbook.
Sync	Gets a Microsoft.Office.Core.Sync object that provides access to the methods and properties of documents that are part of a Document Workspace.
TableStyles	Gets the collection of table styles that are used in the workbook.
Tag	Gets or sets the object that contains data about the workbook.
TemplateRemoveExtData	Gets or sets a value that indicates whether external data references are removed when the workbook is saved as a template.
Theme	Gets the theme that is applied to the workbook.
UpdateLinks	Gets or sets a value that indicates a workbook's setting for updating embedded OLE links.
UpdateRemoteReferences	Gets or sets a value that indicates whether Microsoft Office Excel updates remote references in the workbook.
UserStatus	Gets a 1-based, two-dimensional array that provides information about each user who has the workbook open as a shared list.
VBASigned	Gets a value that indicates whether the Visual Basic for Applications project for the workbook has been digitally signed.
VBProject	Gets the virtual Microsoft.Vbe.Interop.VBProject project that is in the workbook.
VstoSmartTags	Gets the SmartTagCollection associated with the workbook. This type or member is intended to be used only in projects for the 2007 Microsoft Office system. Smart tags are deprecated in Office 2010..
WebOptions	Gets the WebOptions collection, which contains workbook-level attributes used by Microsoft Office Excel when you save a document as a Web page or open a Web page.
Windows	Gets a Windows collection that represents all the windows in the workbook.
Worksheets	Gets a Sheets collection that represents all the worksheets in the workbook.
WritePassword	Gets or sets the write password of a workbook.
WriteReserved	Gets a value that indicates whether the workbook is write-reserved.
WriteReservedBy	Gets the name of the user who currently has write permission for the workbook.
XmlMaps	Gets an XmlMaps collection that represents the schema maps that have been added to the workbook.
XmlNamespaces	Gets an XmlNamespaces collection that represents the XML namespaces contained in the workbook.

Methods

AcceptAllChanges(Object, Object, Object)	Accepts all changes in the shared workbook.
Activate()	Activates the first window associated with the workbook.
AddToFavorites()	Adds a shortcut to the workbook to the Favorites folder.
ApplyTheme(String)	Applies the specified theme to the workbook.
BeginInit()
BreakLink(String, XlLinkType)	Converts formulas linked to other Microsoft Office Excel sources or OLE sources to values.
CanCheckIn()	Gets a value that indicates whether Microsoft Office Excel can check in the workbook to a server.
ChangeFileAccess(XlFileAccess, Object, Object)	Changes the access permissions for the workbook. This might require an updated version to be loaded from the disk.
ChangeLink(String, String, XlLinkType)	Changes a link from one document to another.
CheckIn(Object, Object, Object)	Returns a workbook from a local computer to a server, and sets the local workbook to read-only so that it cannot be edited locally. Calling this method closes the workbook.
CheckInWithVersion(Object, Object, Object, Object)	Sends the workbook from the local computer to a server, and sets the local workbook to read-only so that it cannot be edited locally. Calling this method closes the workbook.
Close(Object, Object, Object)	Closes the workbook.
CreateRibbonExtensibilityObject()	Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface.
CreateRibbonObjects()	Returns an array of OfficeRibbon objects to the CreateRibbonExtensibilityObject() method.
DeleteNumberFormat(String)	Deletes a custom number format from the workbook.
Dispose()	Releases all resources used by the current instance of the WorkbookBase class.
EnableConnections()	Enables data connections within the workbook.
EndInit()
EndReview()	Terminates a review of a file that has been sent for review using the SendForReview(Object, Object, Object, Object) method.
ExclusiveAccess()	Assigns the current user exclusive access to the workbook that is open as a shared list.
ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object)	Saves a workbook in PDF or XPS format.
FinishInitialization()
FollowHyperlink(String, Object, Object, Object, Object, Object, Object)	Displays a cached document, if it has already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application.
ForwardMailer()
GetAutomationObject()	Called by the Visual Studio Tools for Office runtime to get an object that can be used by VBA code in the workbook.
GetHostItem<T>(Type, String)
GetWorkflowTasks()	Returns the collection of workflow tasks for the workbook.
GetWorkflowTemplates()	Returns the collection of workflow templates for the workbook.
HighlightChangesOptions(Object, Object, Object)	Controls how changes are shown in a shared workbook.
Initialize()
InitializeDataBindings()
LinkInfo(String, XlLinkInfo, Object, Object)	Gets the link date and update status.
LinkSources(Object)	Returns an Array of links in the workbook.
LockServerFile()	Locks the workbook on the server to prevent modification.
MergeWorkbook(Object)	Merges changes from one workbook into an open shared workbook.
NewWindow()	Creates a new window.
OnShutdown()
OnStartup()
OpenLinks(String, Object, Object)	Opens the supporting documents for a link or links.
PivotCaches()	Gets a PivotCaches collection that represents all the PivotTable caches in the specified workbook.
Post(Object)	Posts the workbook to a public folder. This method works only with a Microsoft Exchange client connected to a Microsoft Exchange server.
PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object)	Prints the workbook.
PrintPreview(Object)	Shows a preview of the object as it would look when printed.
Protect(Object, Object, Object)	Protects a workbook so that it cannot be modified.
ProtectDocument()	Called by the Visual Studio Tools for Office runtime so that you can reapply password protection to the workbook after the cached data has been saved.
ProtectSharingEx(Object, Object, Object, Object, Object, Object, Object)	Saves the workbook and protects it for sharing.
PurgeChangeHistoryNow(Int32, Object)	Removes entries from the change log for the workbook.
RefreshAll()	Refreshes all external data ranges and PivotTable reports in the workbook.
RejectAllChanges(Object, Object, Object)	Rejects all changes in the shared workbook.
ReloadAs(MsoEncoding)	Reloads a workbook based on an HTML document, using the specified document encoding.
RemoveCustomization()	Removes the customization that was created by using Office development tools in Visual Studio from the workbook.
RemoveDocumentInformation(XlRemoveDocInfoType)	Removes all information of the specified type from the workbook.
RemoveUser(Int32)	Disconnects the specified user from the shared workbook.
Reply()
ReplyAll()
ReplyWithChanges(Object)	Sends an e-mail message to the author of a workbook that has been sent out for review, notifying him or her that a reviewer has completed review of the workbook.
RequestService(Guid)	Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface in a document-level customization.
ResetColors()	Resets the color palette to the default colors.
RunAutoMacros(XlRunAutoMacro)	Runs the Auto_Open, Auto_Close, Auto_Activate, or Auto_Deactivate macro attached to the workbook. This method is included for backward compatibility. You should use the Open, Close, Activate and Deactivate events instead of these macros.
Save()	Saves changes to the workbook.
SaveAs(Object, Object, Object, Object, Object, Object, XlSaveAsAccessMode, Object, Object, Object, Object, Object)	Saves changes to the workbook in a different file.
SaveAsXMLData(String, XmlMap)	Exports the data that has been mapped to the specified XML schema map to an XML data file.
SaveCopyAs(Object)	Saves a copy of the workbook to a file but does not modify the open workbook in memory.
SendFaxOverInternet(Object, Object, Object)	Sends the active sheet in the workbook as a fax to the specified recipients.
SendForReview(Object, Object, Object, Object)	Sends a workbook in an e-mail message for review to the specified recipients.
SendMail(Object, Object, Object)	Sends the workbook by using the installed mail system.
SendMailer(Object, XlPriority)
SetLinkOnData(String, Object)	Sets the name of a procedure that runs whenever a DDE link is updated.
SetPasswordEncryptionOptions(Object, Object, Object, Object)	Sets the options for encrypting the workbook using a password.
ToggleFormsDesign()	Toggles Microsoft Office Excel into and out of design mode.
Unprotect(Object)	Removes protection from the workbook. This method has no effect if the workbook is not protected.
UnprotectDocument()	Called by the Visual Studio Tools for Office runtime so that you can remove password protection from the workbook and enable cached data to be saved.
UnprotectSharing(Object)	Turns off protection for sharing and saves the workbook.
UpdateFromFile()	Updates a read-only workbook from the saved disk version of the workbook if the disk version is more recent than the copy of the workbook that is loaded in memory. If the disk copy has not changed since the workbook was loaded, the in-memory copy of the workbook is not reloaded.
UpdateLink(Object, Object)	Updates a Microsoft Office Excel, DDE, or OLE link (or links).
WebPagePreview()	Displays a preview of the workbook as it would look if saved as a Web page.
XmlImport(String, XmlMap, Object, Object)	Imports an XML data file into the current workbook.
XmlImportXml(String, XmlMap, Object, Object)	Imports an XML data stream that has been previously loaded into memory.

Events

ActivateEvent	Occurs when the workbook is activated.
AddinInstall	Occurs when the workbook is installed as an add-in.
AddinUninstall	Occurs when the workbook is uninstalled as an add-in.
AfterSave	Occurs after the workbook is saved.
AfterXmlExport	Occurs after Microsoft Office Excel saves or exports data from the workbook to an XML data file.
AfterXmlImport	Occurs after an existing XML data connection is refreshed or after new XML data is imported into the workbook.
BeforeClose	Occurs before the workbook closes. If the workbook has been changed, this event occurs before the user is asked to save changes.
BeforePrint	Occurs before the workbook (or anything in it) is printed.
BeforeSave	Occurs before the workbook is saved.
BeforeXmlExport	Occurs before Microsoft Office Excel saves or exports data from the workbook to an XML data file.
BeforeXmlImport	Occurs before an existing XML data connection is refreshed or before new XML data is imported into the workbook.
BindingContextChanged
Deactivate	Occurs when the workbook is deactivated.
Disposed
New	Occurs when a new workbook is created.
NewChart	Occurs when a new chart is created in the workbook.
NewSheet	Occurs when a new sheet is created in the workbook.
Open	Occurs when the workbook is opened.
PivotTableCloseConnection	Occurs after a PivotTable report closes the connection to its data source.
PivotTableOpenConnection	Occurs after a PivotTable report opens the connection to its data source.
RowsetComplete	Occurs when the user navigates through the recordset or invokes the rowset action on an OLAP PivotTable.
SheetActivate	Included for backwards compatibility only.
SheetBeforeDoubleClick	Occurs when any worksheet is double-clicked, before the default double-click action.
SheetBeforeRightClick	Occurs when any worksheet is right-clicked, before the default right-click action.
SheetCalculate	Occurs after any worksheet is recalculated or after any changed data is plotted on a chart.
SheetChange	Occurs when cells in any worksheet are changed by the user or by an external link.
SheetDeactivate	Included for backwards compatibility only.
SheetFollowHyperlink	Occurs when you click any hyperlink in a workbook.
SheetPivotTableAfterValueChange	Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas).
SheetPivotTableBeforeAllocateChanges	Occurs before changes are applied to a PivotTable.
SheetPivotTableBeforeCommitChanges	Occurs before changes are committed against the OLAP data source for a PivotTable.
SheetPivotTableBeforeDiscardChanges	Occurs before changes to a PivotTable are discarded.
SheetPivotTableChangeSync	Occurs after changes to a PivotTable.
SheetPivotTableUpdate	Occurs after the sheet of a PivotTable report has been updated.
SheetSelectionChange	Occurs when the selection changes on any worksheet. Does not occur if the selection is on a chart sheet.
Shutdown	Occurs when the workbook host item shuts down.
Startup
SyncEvent	Occurs when the local copy of a worksheet that is part of a Document Workspace is synchronized with the copy on the server.
WindowActivate	Occurs when any workbook window is activated.
WindowDeactivate	Occurs when any workbook window is deactivated.
WindowResize	Occurs when any workbook window is resized.

Explicit Interface Implementations

EntryPoint.BeginInit()

EntryPoint.EndInit()

EntryPoint.FinishInitialization()

EntryPoint.Initialize()

EntryPoint.InitializeDataBindings()

EntryPoint.OnShutdown()

EntryPoint.OnStartup()

IExtension.ExtensionBase

IWorkbookExtension.CreateRibbonExtensibilityObject()

IWorkbookExtension.CreateRibbonObjects()

IWorkbookExtension.GetAutomationObject()

IWorkbookExtension.ProtectDocument()

IWorkbookExtension.RequestService(Guid)

IWorkbookExtension.UnprotectDocument()