Workbook Methods


Namespace:   Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

System_CAPS_pubmethodAcceptAllChanges(Object, Object, Object)

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.


(Inherited from ISupportInitialize.)

System_CAPS_pubmethodBreakLink(String, XlLinkType)

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.

System_CAPS_pubmethodChangeFileAccess(XlFileAccess, Object, Object)

Changes the access permissions for the workbook. This might require an updated version to be loaded from the disk.

System_CAPS_pubmethodChangeLink(String, String, XlLinkType)

Changes a link from one document to another.

System_CAPS_pubmethodCheckIn(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.

System_CAPS_pubmethodCheckInWithVersion(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.

System_CAPS_pubmethodClose(Object, Object, Object)

Closes the workbook.


Deletes a custom number format from the workbook.


(Inherited from IDisposable.)


Enables data connections within the workbook.


(Inherited from ISupportInitialize.)


Terminates a review of a file that has been sent for review using the SendForReview method.


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

System_CAPS_pubmethodExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object)

Saves a workbook in PDF or XPS format.

System_CAPS_pubmethodFollowHyperlink(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.


This API supports the product infrastructure and is not intended to be used directly from your code.


Returns the collection of workflow tasks for the workbook.


Returns the collection of workflow templates for the workbook.

System_CAPS_pubmethodHighlightChangesOptions(Object, Object, Object)

Controls how changes are shown in a shared workbook.

System_CAPS_pubmethodLinkInfo(String, XlLinkInfo, Object, Object)

Gets the link date and update status.


Returns an Array of links in the workbook.


Locks the workbook on the server to prevent modification.


Merges changes from one workbook into an open shared workbook.


Creates a new window.

System_CAPS_pubmethodOpenLinks(String, Object, Object)

Opens the supporting documents for a link or links.


Gets a Microsoft.Office.Interop.Excel.PivotCaches collection that represents all the PivotTable caches in the specified workbook.


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

System_CAPS_pubmethodPrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object)

Prints the workbook.


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

System_CAPS_pubmethodProtect(Object, Object, Object)

Protects a workbook so that it cannot be modified.

System_CAPS_pubmethodProtectSharingEx(Object, Object, Object, Object, Object, Object, Object)

Saves the workbook and protects it for sharing.

System_CAPS_pubmethodPurgeChangeHistoryNow(Int32, Object)

Removes entries from the change log for the workbook.


Refreshes all external data ranges and PivotTable reports in the workbook.

System_CAPS_pubmethodRejectAllChanges(Object, Object, Object)

Rejects all changes in the shared workbook.


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


Removes the customization that was created by using Office development tools in Visual Studio from the workbook.


Removes all information of the specified type from the workbook.


Disconnects the specified user from the shared workbook.


This API supports the product infrastructure and is not intended to be used directly from your code.


This API supports the product infrastructure and is not intended to be used directly from your code.


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.


Resets the color palette to the default colors.


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.

System_CAPS_pubmethodSaveAs(Object, Object, Object, Object, Object, Object, XlSaveAsAccessMode, Object, Object, Object, Object, Object)

Saves changes to the workbook in a different file.

System_CAPS_pubmethodSaveAsXMLData(String, XmlMap)

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.

System_CAPS_pubmethodSendFaxOverInternet(Object, Object, Object)

Sends the active sheet in the workbook as a fax to the specified recipients.

System_CAPS_pubmethodSendForReview(Object, Object, Object, Object)

Sends a workbook in an e-mail message for review to the specified recipients.

System_CAPS_pubmethodSendMail(Object, Object, Object)

Sends the workbook by using the installed mail system.

System_CAPS_pubmethodSendMailer(Object, XlPriority)

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubmethodSetLinkOnData(String, Object)

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

System_CAPS_pubmethodSetPasswordEncryptionOptions(Object, Object, Object, Object)

Sets the options for encrypting the workbook using a password.


Toggles Microsoft Office Excel into and out of design mode.


Removes protection from the workbook. This method has no effect if the workbook is not 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 has not changed since the workbook was loaded, the in-memory copy of the workbook is not reloaded.

System_CAPS_pubmethodUpdateLink(Object, Object)

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.

System_CAPS_pubmethodXmlImport(String, XmlMap, Object, Object)

Imports an XML data file into the current workbook.

System_CAPS_pubmethodXmlImportXml(String, XmlMap, Object, Object)

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

Return to top