Workbook Interface

Reserved for internal use.

Reserved for internal use.

True if labels can be used in worksheet formulas. The default value is False. Read/write Boolean.

Gets or sets whether certain worksheet functions use the latest accuracy algorithms to calculate their results.

Returns a Chart object that represents the active chart (either an embedded chart or a chart sheet). An embedded chart is considered active when it's either selected or activated. When no chart is active, this property returns Nothing. Read-only.

Returns an object that represents the active sheet (the sheet on top) in the active workbook or in the specified window or workbook. Returns Nothing if no sheet is active. Read-only.

Gets an object that represents the active slicer in the active workbook or in the specified workbook.

When used without an object qualifier, this property returns an Application object that represents the Microsoft Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object (you can use this property with an OLE Automation object to return the application of that object). Read-only.

Returns or sets the author of the comment. Read-only String.

Returns or sets the number of minutes between automatic updates to the shared workbook. Read/write Integer.

True if current changes to the shared workbook are posted to other users whenever the workbook is automatically updated. False if changes aren’t posted (this workbook is still synchronized with changes made by other users). The default value is True. Read/write Boolean.

Returns a DocumentProperties collection that represents all the built-in document properties for the specified workbook. Read-only.

Returns a number whose rightmost four digits are the minor calculation engine version number and whose other digits (on the left) are the major version of Microsoft Excel. For a Workbook object, this property returns the information about the version of Excel that the workbook was last fully recalculated by. Read-only Integer.

True if the workbook distinguishes between upper and lower case when comparing content. Read-only Boolean (bool in C#).

Returns or sets the number of days shown in the shared workbook's change history. Read/write Integer.

True will cause all charts in the current document to track the actual data point to which it’s attached. False will revert back to tracking the index of the data point. Boolean (bool in C#) Read/Write.

Returns a Sheets collection that represents all the chart sheets in the specified workbook. Read-only.

Controls whether or not the compatibility checker is run automatically when the workbook is saved. Read/write.

Returns the code name for the object. Read-only String. The value that you see in the cell to the right of (Name) in the Properties window is the code name of the selected object. At design time, you can change the code name of an object by changing this value. You cannot programmatically change this property at run time.

Returns or sets colors in the palette for the workbook. The palette has 56 entries, each represented by an RGB value. Read/write Object.

Returns a CommandBars object that represents the Microsoft Excel command bars. Read-only.

Returns a Comments collection that represents all the comments for the specified worksheet. Read-only.

Returns or sets the way conflicts are to be resolved whenever a shared workbook is updated. Read/write XlSaveConflictResolution.

The Connections property establishes a connection between the workbook and an ODBC or an OLEDB data source and refreshes the data without prompting the user. Read-only.

Disables the external connections or links in the workbook. Read-only

Returns the object that represents the container application for the specified OLE object. Read-only Object.

Returns a MetaProperties collection that describes the metadata stored in the workbook. Read-only.

True if a backup file is created when this file is saved. Read-only Boolean.

Returns a constant in the XlCreator enumeration that indicates the application in which this object was created. If the object was created in Microsoft Excel, this property returns the string XCEL, which is equivalent to the hexadecimal number 5843454C. Read-only XlCreator.

Returns or sets a DocumentProperties collection that represents all the custom document properties for the specified workbook.

Returns a CustomViews collection that represents all the custom views for the workbook.

Returns a. CustomXMLParts collection that represents the custom XML in the XML data store. Read-only.

True if the workbook uses the 1904 date system. Read/write Boolean.

Specifies the table style from the TableStyles collection that is used as the default style for PivotTables. Read/write.

Gets or sets the style from the TableStyles object that is used as the default style for slicers.

Specifies the table style from the TableStyles collection that is used as the default TableStyle. Read/write

The name of the default slicer style of the workbook. Object (object in C#). Read/Write

Reserved for internal use.

Returns or sets how shapes are displayed. Read/write XlDisplayDrawingObjects.

A Boolean value that determines whether ink comments are displayed in the workbook. Read/write Boolean.

Returns a DocumentInspectors collection that represents the Document Inspector modules for the specified workbook. Read-only.

Returns a 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.

Returns or sets if the user should be prompted to convert the workbook if the workbook contains features that are not supported by versions of Excel earlier than short_Excel2007. Read/write

Saves changed files, of all formats, on a timed interval. Read/write Boolean.

Returns a String specifying the name of the algorithm encryption provider that 1st_Excel12 uses when encrypting documents. Read/write.

True if the e-mail composition header and the envelope toolbar are both visible. Read/write Boolean.

Returns a Sheets collection that represents all the Microsoft Excel 4.0 international macro sheets in the specified workbook. Read-only.

Returns a Sheets collection that represents all the Microsoft Excel 4.0 macro sheets in the specified workbook. Read-only.

The Excel8CompatibilityMode property provides developers with a way to check if the workbook is in compatibility mode. Read-only

Returns the file format and/or type of the workbook. Read-only XlFileFormat.

Returns or sets a Boolean that indicates whether a workbook is final. Read/write

Forces a full calculation of a workbook. Read/write.

Returns the name of the object, including its path on disk, as a string. Read-only String.

Returns a String indicating the name of the object, including its path on disk, as a string. Read-only.

Reserved for internal use.

True if the workbook has a protection password. Read-only Boolean.

True if the workbook has a routing slip. Read/write Boolean.

Returns a Boolean that represents whether a workbook has an attached Microsoft Visual Basic for Applications project. Read-only.

True if changes to the shared workbook are highlighted on-screen. Read/write Boolean.

Returns the HTMLProject object in the specified workbook, which represents a top-level project branch as in the Project Explorer in the Microsoft Script Editor. Read-only.

This property is used to filter data in a workbook based on a cell icon from the IconSets collection. Read-only.

A Boolean value that specifies whether list borders are visible when a list is not active. Returns True if the border is visible. Read/write Boolean.

True if the workbook is running as an add-in. Read/write Boolean.

True if the specified workbook is being edited in place. False if the workbook has been opened in Microsoft Excel for editing. Read-only Boolean.

True if change tracking is enabled for the shared workbook. Read/write Boolean.

Reserved for internal use.

True if changes to the shared workbook are shown on a separate worksheet. Read/write Boolean.

You have requested Help for a Visual Basic keyword used only on the Macintosh. For information about this keyword, consult the language reference Help included with Microsoft Office Macintosh Edition.

Returns the top level Model object which is the one Data Model for the workbook. Read-only

Reserved for internal use.

True if the workbook is open as a shared list. Read-only Boolean.

Returns the name of the object. Read-only String.

Returns a Names collection that represents all the names in the specified workbook (including all worksheet-specific names). Read-only Names object.

Reserved for internal use.

Reserved for internal use.

Reserved for internal use.

Returns the parent object for the specified object. Read-only.

Returns or sets the password that must be supplied to open the specified workbook. Read/write String.

Returns a String indicating the algorithm Microsoft Excel uses to encrypt passwords for the specified workbook. Read-only.

True if Microsoft Excel encrypts file properties for the specified password-protected workbook. Read-only Boolean.

Returns an Integer indicating the key length of the algorithm Microsoft Excel uses when encrypting passwords for the specified workbook. Read-only.

Returns a String specifying the name of the algorithm encryption provider that Microsoft Excel uses when encrypting passwords for the specified workbook. Read-only.

Returns the complete path to the application, excluding the final separator and name of the application. Read-only String.

Returns a Permission object that represents the permission settings in the specified workbook.

True if filter and sort settings for lists are included in the user's personal view of the shared workbook. Read/write Boolean.

True if print settings are included in the user's personal view of the shared workbook. Read-write Boolean.

Returns an object that represents a collection of all the PivotTable reports on a worksheet. Read-only.

True if calculations in this workbook will be done using only the precision of the numbers as they’re displayed. Read/write Boolean.

True if the order of the sheets in the workbook is protected. Read-only Boolean.

True if the windows of the workbook are protected. Read-only Boolean.

Returns the PublishObjects collection. Read-only.

Returns True if the object has been opened as read-only. Read-only Boolean.

True if the workbook was saved as read-only recommended. Read-only Boolean.

True if personal information can be removed from the specified workbook. The default value is False. Read/write Boolean.

Returns a Research object that represents the research service for a workbook. Read-only.

Returns 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). Read-only Integer.

True if the workbook has been routed to the next recipient. False if the workbook needs to be routed. Read-only Boolean.

Returns a RoutingSlip object that represents the routing slip for the workbook. Reading this property if there's no routing slip causes an error (check the HasRoutingSlip property first). Read-only.

True if no changes have been made to the specified workbook since it was last saved. Read/write Boolean.

True if Microsoft Excel saves external link values with the workbook. Read/write Boolean.

Returns a ServerPolicy object that represents a policy specified for a workbook stored on a server running 2nd_OSS_NoVersion 2007. Read-only.

Allows a developer to interact with the list of published objects in the workbook that are shown on the server. Read-only.

Returns a SharedWorkspace object that represents the Document Workspace in which a specified document is located. Read-only.

Returns a Sheets collection that represents all the sheets in the specified workbook. Read-only Sheets object.

True if the Conflict History worksheet is visible in the workbook that's open as a shared list. Read/write Boolean.

This property controls the visibility of the PivotChart Filter Pane. Read/write.

True (default) if the PivotTable field list can be shown. Read/write Boolean.

Returns the digital signatures for a workbook. Read-only.

Gets the SlicerCaches object associated with the workbook.

Returns a SmartDocument object that represents the settings for a smart document solution. Read-only.

Returns a SmartTagOptions object representing the options that can be performed with a smart tag.

Returns a Styles collection that represents all the styles in the specified workbook. Read-only.

Reserved for internal use.

Returns a TableStyles collection object for the current workbook that refers to the styles used in the current workbook. Read-only.

True if external data references are removed when the workbook is saved as a template. Read/write Boolean.

Returns the theme applied to the current workbook. Read-only.

Reserved for internal use.

Returns or sets an XlUpdateLinks constant indicating a workbook's setting for updating embedded OLE links. Read/write.

True if Microsoft Excel updates remote references in the workbook. Read/write Boolean.

Reserved for internal use.

Returns a 1-based, two-dimensional array that provides information about each user who has the workbook open as a shared list. The first element of the second dimension is the name of the user, the second element is the date and time when the user last opened the workbook, and the third element is a number indicating the type of list (1 indicates exclusive, and 2 indicates shared). Read-only Object.

True if the workbook uses search patterns that match the entire content of a cell. Read-only Boolean (bool in C#).

True if the workbook enables wildcards for character string comparisons and searching. Read-only Boolean (bool in C#).

True if the Visual Basic for Applications project for the specified workbook has been digitally signed. Read-only Boolean.

Returns a VBProject object that represents the Visual Basic project in the specified workbook. Read-only.

Returns the WebOptions collection, which contains workbook-level attributes used by Microsoft Excel when you save a document as a Web page or open a Web page. Read-only.

Returns a Windows collection that represents all the windows in the specified workbook. Read-only Windows object.

Returns a Sheets collection that represents all the worksheets in the specified workbook. Read-only Sheets object.

Returns or sets a String for the write password of a workbook. Read/write.

True if the workbook is write-reserved. Read-only Boolean.

Returns the name of the user who currently has write permission for the workbook. Read-only String.

Returns an XmlMaps collection that represents the schema maps that have been added to the specified workbook. Read-only.

Returns an XmlNamespaces collection that represents the XML namespaces contained in the specified workbook. Read-only.

Reserved for internal use.

Reserved for internal use.

Reserved for internal use.

Accepts all changes in the specified shared workbook.

Adds a shortcut to the workbook or a hyperlink to the Favorites folder.

Applies the specified theme to the current workbook.

Converts formulas linked to other Microsoft Excel sources or OLE sources to values.

True if Microsoft Excel can check in a specified workbook to a server.

Changes the access permissions for the workbook. This may 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 will also close the workbook.

Saves a workbook to a server from a local computer, and sets the local workbook to read-only so that it cannot be edited locally.

Closes the object.

Deletes a custom number format from the workbook.

Reserved for internal use.

Reserved for internal use.

The EnableConnections() method allows developers to programmatically enable data connections within the workbook for the user.

Terminates a review of a file that has been sent for review using the SendForReview(Object, Object, Object, Object) method.

Assigns the current user exclusive access to the workbook that's open as a shared list.

The ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object) method is used to publish a workbook to either the PDF or XPS format.

Displays a cached document if it’s already been downloaded. Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application.

You have requested Help for a Visual Basic keyword used only on the Macintosh. For information about this keyword, consult the language reference Help included with Microsoft Office Macintosh Edition.

Returns the collection of WorkflowTask objects for the specified workbook.

Returns the collection of WorkflowTemplate objects for the specified workbook.

Controls how changes are shown in a shared workbook.

Returns the link date and update status. Object.

Returns an array of links in the workbook. The names in the array are the names of the linked documents, editions, or DDE or OLE servers. Returns Empty if there are no links. Object.

Locks the workbook on the server to prevent modification.

Merges changes from one workbook into an open workbook.

Creates a new window or a copy of the specified window.

Opens the supporting documents for a link or links.

Returns a PivotCaches collection that represents all the PivotTable caches in the specified workbook. Read-only.

Reserved for internal use.

Posts the specified workbook to a public folder. This method works only with a Microsoft Exchange client connected to a Microsoft Exchange server.

Prints the object.

Reserved for internal use.

Shows a preview of the object as it would look when printed.

Protects a workbook so that it cannot be modified.

Saves the workbook and protects it for sharing.

Reserved for internal use.

Removes entries from the change log for the specified 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 specified workbook.

Rejects all changes in the specified shared workbook.

Reloads a workbook based on an HTML document, using the specified document encoding.

Removes all information of the specified type from the workbook.

Disconnects the specified user from the shared workbook.

You have requested Help for a Visual Basic keyword used only on the Macintosh. For information about this keyword, consult the language reference Help included with Microsoft Office Macintosh Edition.

You have requested Help for a Visual Basic keyword used only on the Macintosh. For information about this keyword, consult the language reference Help included with Microsoft Office Macintosh Edition.

Sends an e-mail message to the author of a workbook that has been sent out for review, notifying them that a reviewer has completed review of the workbook.

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 specified 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 doesn't modify the open workbook in memory.

Reserved for internal use.

Sends a worksheet 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.

You have requested Help for a Visual Basic keyword used only on the Macintosh. For information about this keyword, consult the language reference Help included with Microsoft Office Macintosh Edition.

Sets the name of a procedure that runs whenever a DDE link is updated.

Sets the options for encrypting workbooks using passwords.

Toggles form design mode on or off.

Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected.

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 hasn't changed since the workbook was loaded, the in-memory copy of the workbook isn't reloaded.

Updates a Microsoft Excel, DDE, or OLE link (or links).

Displays a preview of the specified workbook as it would look if saved as a Web page.

Imports an XML data file into the current workbook. Returns XlXmlImportResult.

Imports an XML data stream that has been previously loaded into memory. Returns XlXmlImportResult.

Occurs when a 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 the workbook is saved.

Occurs after Excel saves or exports data from the specified workbook to an XML data file.

Occurs after an existing XML data connection is refreshed or after new XML data is imported into the specified Excel 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 Excel saves or exports data from the specified workbook to an XML data file.

Occurs before an existing XML data connection is refreshed or before new XML data is imported into an Excel workbook.

Occurs when the workbook is deactivated.

Occurs after the Excel data model is changed.

Occurs when a new chart is created in the workbook.

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.

The event is raised when the user either drills through the recordset or invokes the rowset action on an OLAP PivotTable.

Occurs when any sheet is activated.

Occurs before the worksheet is deleted.

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 Microsoft Excel.

Occurs when a callout gallery’s icons (dynamic and static) have completed rendering for a worksheet.

Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas).

Occurs before changes are applied to a PivotTable.

Occurs before changes are committed against the OLAP data source for a PivotTable.

Occurs before changes to a PivotTable are discarded.

Occurs after changes to a PivotTable.

Occurs after the sheet of the PivotTable report has been updated.

Occurs when the selection changes on any worksheet (doesn't occur if the selection is on a chart sheet).

Occurs after the sheet table has been updated.

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.