Workbook Members (2007 System)
Include Protected Members
Include Inherited Members
Represents a workbook in Visual Studio Tools for Office projects for Microsoft Office Excel.
The Workbook type exposes the following members.
Constructors
Name
Description
.gif "Public method")
Infrastructure. Overloaded.
Top
Methods
Name
Description
Infrastructure.
Infrastructure.
Infrastructure.
Accepts all changes in the shared workbook.
Activates the first window associated with the workbook.
Adds a shortcut to the workbook to the Favorites folder.
Applies the specified theme to the workbook.
Infrastructure.
Converts formulas linked to other Microsoft Office Excel sources or OLE sources to values.
Gets a value that indicates whether Microsoft Office Excel can check in the workbook to a server.
Changes the access permissions for the workbook. This might require an updated version to be loaded from the disk.
Changes a link from one document to another.
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.
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.
.gif "Protected method")
(Inherited from RemoteComponent.)
Closes the workbook.
CreateRibbonExtensibilityObject
Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface.
Returns an array of OfficeRibbon objects to the CreateRibbonExtensibilityObject method.
Deletes a custom number format from the workbook.
Overloaded.
Infrastructure.
Infrastructure.
Enables data connections within the workbook.
Infrastructure.
Terminates a review of a file that has been sent for review using the SendForReview method.
Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Assigns the current user exclusive access to the workbook that is open as a shared list.
Saves a workbook in PDF or XPS format.
(Inherited from RemoteComponent.)
(Inherited from EntryPointComponentBase.)
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.
Infrastructure.
Infrastructure. Use the Colors property instead of this method.
Called by the Visual Studio Tools for Office runtime to get an object that can be used by VBA code in the workbook.
Serves as a hash function for a particular type. (Inherited from Object.)
(Inherited from RemoteComponent.)
Infrastructure.
(Inherited from RemoteComponent.)
Gets the type of the current instance. (Inherited from Object.)
.gif "Static member")
Returns a workbook host item that extends the functionality of the specified native Excel workbook.
Returns the collection of workflow tasks for the workbook.
Returns the collection of workflow templates for the workbook.
Returns a value that indicates whether an Excel Microsoft.Office.Tools.Excel.Workbook host item has been created for the specified native Excel _Workbook.
Controls how changes are shown in a shared workbook.
Infrastructure. (Overrides EntryPointComponentBase.Initialize().)
(Inherited from RemoteComponent.)
(Inherited from EntryPointComponentBase.)
Gets the link date and update status.
Returns an Array of links in the workbook.
Locks the workbook on the server to prevent modification.
Creates a shallow copy of the current Object. (Inherited from Object.)
Merges changes from one workbook into an open shared workbook.
Creates a new window.
(Inherited from EntryPointBindableComponentBase.)
Infrastructure. (Overrides EntryPointComponentBase.OnShutdown().)
Infrastructure. (Overrides EntryPointComponentBase.OnStartup().)
Opens the supporting documents for a link or links.
Gets a PivotCaches collection that represents all the PivotTable caches in the specified workbook.
Creates a PivotTable object.
Posts the workbook to a public folder. This method works only with a Microsoft Exchange client connected to a Microsoft Exchange server.
Prints the workbook.
Prints the workbook.
Shows a preview of the object as it would look when printed.
Protects a workbook so that it cannot be modified.
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.
Saves the workbook and protects it for sharing.
Saves the workbook and protects it for sharing.
Removes entries from the change log for the workbook.
Causes a foreground smart tag check to occur automatically annotating data that was not annotated before.
Refreshes all external data ranges and PivotTable reports in the workbook.
Rejects all changes in the shared workbook.
Reloads a workbook based on an HTML document, using the specified document encoding.
Removes the Visual Studio Tools for Office customization from the workbook.
Removes all information of the specified type from the workbook.
Disconnects the specified user from the shared workbook.
Infrastructure.
Infrastructure.
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.
Returns an object that implements the Microsoft.Office.Core.IRibbonExtensibility interface in a document-level customization.
Resets the color palette to the default colors.
Routes the workbook, using the workbook's current routing slip.
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.
Saves changes to the workbook.
Saves changes to the workbook in a different file.
Exports the data that has been mapped to the specified XML schema map to an XML data file.
Saves a copy of the workbook to a file but does not modify the open workbook in memory.
Infrastructure.
Sends the active sheet in the workbook as a fax to the specified recipients.
Sends a workbook in an e-mail message for review to the specified recipients.
Sends the workbook by using the installed mail system.
Infrastructure.
Infrastructure. Use the Colors property instead of this method.
Sets the name of a procedure that runs whenever a DDE link is updated.
Sets the options for encrypting the workbook using a password.
(Inherited from RemoteComponent.)
Toggles Microsoft Office Excel into and out of design mode.
Returns a string that represents the current object. (Inherited from Object.)
Removes protection from the workbook. This method has no effect if the workbook is not protected.
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.
Turns off protection for sharing and saves the workbook.
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.
Updates a Microsoft Office Excel, DDE, or OLE link (or links).
Displays a preview of the workbook as it would look if saved as a Web page.
Imports an XML data file into the current workbook.
Imports an XML data stream that has been previously loaded into memory.
Top
Properties
Name
Description
.gif "Public property")
Infrastructure.
Infrastructure.
Gets or sets a value that indicates whether labels can be used in worksheet formulas.
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 nulla null reference (Nothing in Visual Basic).
Gets the active sheet (the sheet on top).
Gets an Application that represents the creator of the workbook.
Gets or sets the author of the workbook.
Gets or sets the number of minutes between automatic updates to the shared workbook.
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.
(Inherited from EntryPointBindableComponentBase.)
Gets a Microsoft.Office.Core.DocumentProperties collection that represents all the built-in document properties for the workbook.
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.
Gets or sets the number of days shown in the shared workbook's change history.
Gets a Sheets collection that represents all the chart sheets in the workbook.
Gets or sets a value that indicates whether to run the compatibility checker automatically when the workbook is saved.
Infrastructure.
Gets or sets colors in the palette for the workbook.
Gets a Microsoft.Office.Core.CommandBars object that represents the Microsoft Office Excel command bars.
Gets or sets the comments attached to the workbook.
Gets or sets the way conflicts are to be resolved whenever a shared workbook is updated.
Gets the collection of connections between the workbook and a data source.
Gets a value that indicates whether to disable the external connections or links in the workbook.
Gets the object that represents the container application for the workbook.
(Inherited from EntryPointBindableComponentBase.)
Gets a collection of properties that describe metadata that is stored in the workbook.
Gets a value that indicates whether a backup file is created when this file is saved.
Gets the application in which the workbook was created.
Gets a Microsoft.Office.Core.DocumentProperties collection that represents all the custom document properties for the workbook.
Gets a CustomViews collection that represents all the custom views for the workbook.
Gets the collection of custom XML parts in the workbook.
(Inherited from EntryPointBindableComponentBase.)
.gif "Protected property")
(Inherited from EntryPointComponentBase.)
Gets or sets a value that indicates whether the workbook uses the 1904 date system.
(Inherited from EntryPointBindableComponentBase.)
Gets or sets the table style from the TableStyles property that is used as the default style for PivotTable reports in the workbook.
Gets or sets the table style from the TableStyles property that is used as the default style for tables in the workbook.
(Inherited from RemoteComponent.)
Included for backwards compatibility only.
Gets or sets how shapes are displayed.
Gets or sets a value that indicates whether ink comments are displayed in the workbook.
Gets the collection of Document Inspector modules for the workbook.
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.
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.
Gets or sets a value that indicates whether Microsoft Office Excel saves changed files, of all formats, on a timed interval.
Gets or sets the name of the algorithm encryption provider that Microsoft Office Excel 2007 uses when encrypting documents.
Gets or sets a value that indicates whether the e-mail composition header and the envelope toolbar are both visible.
Gets a Sheets collection that represents all the Microsoft Office Excel 4.0 international macro sheets in the workbook.
Gets a Sheets collection that represents all the Microsoft Office Excel 4.0 macro sheets in the workbook.
Gets a value that indicates whether the workbook is in compatibility mode.
Gets the file format and type of the workbook.
Gets or sets a value that indicates whether the workbook is final.
Gets or sets a value that indicates whether to force a full calculation of a workbook.
Gets the name of the object, including its path on disk.
Gets the name of the object, including its path on disk.
Infrastructure.
Gets a value that indicates whether the workbook has a protection password.
Gets or sets a value that indicates whether the workbook has a routing slip.
Gets a value that indicates whether a workbook has an attached Microsoft Visual Basic for Applications (VBA) project.
Gets or sets a value that indicates whether changes to the shared workbook are highlighted on screen.
(Inherited from RemoteComponent.)
Gets the Microsoft.Office.Core.HTMLProject in the workbook, which represents a top-level project branch.
Gets the collection of built-in icon sets that can be used to apply a conditional formatting rule to a range in the workbook.
(Inherited from RemoteComponent.)
Gets or sets a value that indicates whether list borders are visible when a list is not active.
Gets a Workbook that represents the underlying native object for the Workbook.
(Inherited from RemoteComponent.)
Gets or sets a value that indicates whether the workbook is running as an add-in.
Gets a value that indicates whether the specified workbook is being edited in place.
(Inherited from RemoteComponent.)
Gets or sets a value that indicates whether change tracking is enabled for the shared workbook.
Gets or sets the keywords attached to the workbook.
Gets or sets a value that indicates whether changes to the shared workbook are shown on a separate worksheet.
Infrastructure.
Included for backwards compatibility only.
Gets a value that indicates whether the workbook is open as a shared list.
Gets the name of the workbook.
Gets a Names collection that represents all the names in the workbook (including all worksheet-specific names).
Included for backwards compatibility only.
Included for backwards compatibility only.
Included for backwards compatibility only.
Gets the parent object for the workbook.
Gets or sets the password that must be supplied to open the workbook.
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.
Gets the key length of the algorithm that Microsoft Office Excel uses when encrypting passwords for the workbook.
Gets the name of the algorithm encryption provider that Microsoft Office Excel uses when encrypting passwords for the workbook.
Gets the complete path to the application, excluding the final separator and name of the application.
Gets a Microsoft.Office.Core.Permission object that represents the permission settings in the workbook.
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.
Gets or sets a value that indicates whether print settings are included in the user's personal view of the shared workbook.
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.
(Inherited from RemoteComponent.)
Gets a value that indicates whether the order of the sheets in the workbook is protected.
Gets a value that indicates whether the windows of the workbook are protected.
Gets the PublishObjects collection.
Gets a value that indicates whether the workbook has been opened as read-only.
Gets or sets a value that indicates whether the workbook was saved as read-only recommended.
Gets or sets a value that indicates whether personal information can be removed from the workbook.
Gets an object that represents the research service for the workbook.
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).
Gets a value that indicates whether the workbook has been routed to the next recipient.
Gets a RoutingSlip object that represents the routing slip for the workbook.
Gets or sets a value that indicates whether no changes have been made to the workbook since it was last saved.
Gets or sets a value that indicates whether Microsoft Office Excel saves external link values with the workbook.
Gets an object that represents a policy specified for a workbook that is stored on a server running Microsoft Office SharePoint Server 2007.
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 2007 server.
Gets a Microsoft.Office.Core.SharedWorkspace that represents the Document Workspace in which the workbook is located.
Gets a Sheets collection that represents all the sheets in the workbook.
Gets or sets a value that indicates whether the Conflict History worksheet is visible in the workbook that is open as a shared list.
Gets or sets a value that indicates whether the PivotChart Filter Pane is visible.
Gets or sets a value that indicates whether the PivotTable field list can be shown.
Gets the collection of digital signatures for the workbook.
(Inherited from RemoteComponent.)
Gets a Microsoft.Office.Core.SmartDocument that represents the settings for a smart document solution.
Gets a SmartTagOptions object representing the options that can be performed with a smart tag.
Gets a Styles collection that represents all the styles in the workbook.
Gets or sets the subject for the mailer or routing slip.
Gets a Microsoft.Office.Core.Sync object that provides access to the methods and properties of documents that are part of a Document Workspace.
Gets the collection of table styles that are used in the workbook.
(Inherited from RemoteComponent.)
Gets or sets a value that indicates whether external data references are removed when the workbook is saved as a template.
Gets the theme that is applied to the workbook.
Gets or sets the title of the Web page when the workbook is saved as a Web page.
Gets or sets a value that indicates a workbook's setting for updating embedded OLE links.
Gets or sets a value that indicates whether Microsoft Office Excel updates remote references in the workbook.
Infrastructure.
Gets a 1-based, two-dimensional array that provides information about each user who has the workbook open as a shared list.
Gets a value that indicates whether the Visual Basic for Applications project for the workbook has been digitally signed.
Gets the virtual Microsoft.Vbe.Interop.VBProject project that is in the workbook.
Gets the Microsoft.Office.Tools.SmartTagCollection associated with the workbook.
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.
Gets a Windows collection that represents all the windows in the workbook.
Gets a Sheets collection that represents all the worksheets in the workbook.
Gets or sets the write password of a workbook.
Gets a value that indicates whether the workbook is write-reserved.
Gets the name of the user who currently has write permission for the workbook.
Gets an XmlMaps collection that represents the schema maps that have been added to the workbook.
Gets an XmlNamespaces collection that represents the XML namespaces contained in the workbook.
Top
Events
Name
Description
.gif "Public event")
Occurs when the workbook is activated.
Occurs when the workbook is installed as an add-in.
Occurs when the workbook is uninstalled as an add-in.
Occurs after Microsoft Office Excel saves or exports data from the workbook to an XML data file.
Occurs after an existing XML data connection is refreshed or after new XML data is imported into the workbook.
Occurs before the workbook closes. If the workbook has been changed, this event occurs before the user is asked to save changes.
Occurs before the workbook (or anything in it) is printed.
Occurs before the workbook is saved.
Occurs before Microsoft Office Excel saves or exports data from the workbook to an XML data file.
Occurs before an existing XML data connection is refreshed or before new XML data is imported into the workbook.
(Inherited from EntryPointBindableComponentBase.)
Occurs when the workbook is deactivated.
(Inherited from RemoteComponent.)
Occurs when a new workbook is created.
Occurs when a new sheet is created in the workbook.
Occurs when the workbook is opened.
Occurs after a PivotTable report closes the connection to its data source.
Occurs after a PivotTable report opens the connection to its data source.
Occurs when the user navigates through the recordset or invokes the rowset action on an OLAP PivotTable.
Occurs when any sheet is activated.
Occurs when any worksheet is double-clicked, before the default double-click action.
Occurs when any worksheet is right-clicked, before the default right-click action.
Occurs after any worksheet is recalculated or after any changed data is plotted on a chart.
Occurs when cells in any worksheet are changed by the user or by an external link.
Occurs when any sheet is deactivated.
Occurs when you click any hyperlink in a workbook.
Occurs after the sheet of a PivotTable report has been updated.
Occurs when the selection changes on any worksheet. Does not occur if the selection is on a chart sheet.
Occurs when the workbook host item shuts down.
Occurs after the workbook is running and all the initialization code in the assembly has been run.
Occurs when the local copy of a worksheet that is part of a Document Workspace is synchronized with the copy on the server.
Occurs when any workbook window is activated.
Occurs when any workbook window is deactivated.
Occurs when any workbook window is resized.
Top
Explicit Interface Implementations
Name
Description
.gif "Explicit interface implemetation")
.gif "Private method")
IEntryPoint.FinishInitialization
(Inherited from EntryPointComponentBase.)
(Inherited from EntryPointComponentBase.)
ISupportInitializeControl.InitializeControl
Infrastructure.
IEntryPoint.InitializeDataBindings
(Inherited from EntryPointComponentBase.)
Infrastructure.
Infrastructure.
(Inherited from EntryPointComponentBase.)
IServiceProviderCallback.RequestService
Infrastructure.
Top