Workbook Interface

 

Represents a workbook in Excel projects created by using the Office development tools in Visual Studio.

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

[GuidAttribute("b74cbb86-9c9f-4172-9ae7-3ce4a7bfa5eb")]
public interface Workbook : IBindableComponent, IComponent, IDisposable, 
	ISupportInitialize

NameDescription
System_CAPS_pubpropertyAccuracyVersion

Specifies whether certain worksheet functions use the latest accuracy algorithms to calculate their results.

System_CAPS_pubpropertyActiveChart

Gets a Microsoft.Office.Interop.Excel.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.

System_CAPS_pubpropertyActiveSheet

Gets the active sheet (the sheet on top).

System_CAPS_pubpropertyActiveSlicer

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

System_CAPS_pubpropertyApplication

Gets an Microsoft.Office.Interop.Excel.Application that represents the creator of the workbook.

System_CAPS_pubpropertyAutoUpdateFrequency

Gets or sets the number of minutes between automatic updates to the shared workbook.

System_CAPS_pubpropertyAutoUpdateSaveChanges

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.

System_CAPS_pubpropertyBindingContext

(Inherited from IBindableComponent.)

System_CAPS_pubpropertyBuiltinDocumentProperties

Gets a Microsoft.Office.Core.DocumentProperties collection that represents all the built-in document properties for the workbook.

System_CAPS_pubpropertyCalculationVersion

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.

System_CAPS_pubpropertyChangeHistoryDuration

Gets or sets the number of days shown in the shared workbook's change history.

System_CAPS_pubpropertyCharts

Gets a Microsoft.Office.Interop.Excel.Sheets collection that represents all the chart sheets in the workbook.

System_CAPS_pubpropertyCheckCompatibility

Gets or sets a value that indicates whether to run the compatibility checker automatically when the workbook is saved.

System_CAPS_pubpropertyColors

Gets or sets colors in the palette for the workbook.

System_CAPS_pubpropertyCommandBars

Gets a Microsoft.Office.Core.CommandBars object that represents the Microsoft Office Excel command bars.

System_CAPS_pubpropertyConflictResolution

Gets or sets the way conflicts are to be resolved whenever a shared workbook is updated.

System_CAPS_pubpropertyConnections

Gets the collection of connections between the workbook and a data source.

System_CAPS_pubpropertyConnectionsDisabled

Gets a value that indicates whether to disable the external connections or links in the workbook.

System_CAPS_pubpropertyContainer

Gets the object that represents the container application for the workbook.

System_CAPS_pubpropertyContentTypeProperties

Gets a collection of properties that describe metadata that is stored in the workbook.

System_CAPS_pubpropertyCreateBackup

Gets a value that indicates whether a backup file is created when this file is saved.

System_CAPS_pubpropertyCreator

Gets the application in which the workbook was created.

System_CAPS_pubpropertyCustomDocumentProperties

Gets a Microsoft.Office.Core.DocumentProperties collection that represents all the custom document properties for the workbook.

System_CAPS_pubpropertyCustomViews

Gets a Microsoft.Office.Interop.Excel.CustomViews collection that represents all the custom views for the workbook.

System_CAPS_pubpropertyCustomXMLParts

Gets the collection of custom XML parts in the workbook.

System_CAPS_pubpropertyDataBindings

(Inherited from IBindableComponent.)

System_CAPS_pubpropertyDataHost

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

System_CAPS_pubpropertyDate1904

Gets or sets a value that indicates whether the workbook uses the 1904 date system.

System_CAPS_pubpropertyDefaultExtension

Gets the default extension for this Workbook object.

System_CAPS_pubpropertyDefaultPivotTableStyle

Gets or sets the table style from the TableStyles property that is used as the default style for PivotTable reports in the workbook.

System_CAPS_pubpropertyDefaultSlicerStyle

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

System_CAPS_pubpropertyDefaultTableStyle

Gets or sets the table style from the TableStyles property that is used as the default style for tables in the workbook.

System_CAPS_pubpropertyDisplayDrawingObjects

Gets or sets how shapes are displayed.

System_CAPS_pubpropertyDisplayInkComments

Gets or sets a value that indicates whether ink comments are displayed in the workbook.

System_CAPS_pubpropertyDocumentInspectors

Gets the collection of Document Inspector modules for the workbook.

System_CAPS_pubpropertyDocumentLibraryVersions

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.

System_CAPS_pubpropertyDoNotPromptForConvert

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.

System_CAPS_pubpropertyEnableAutoRecover

Gets or sets a value that indicates whether Microsoft Office Excel saves changed files, of all formats, on a timed interval.

System_CAPS_pubpropertyEncryptionProvider

Gets or sets the name of the algorithm encryption provider that Microsoft Office Excel uses when encrypting documents.

System_CAPS_pubpropertyEnvelopeVisible

Gets or sets a value that indicates whether the e-mail composition header and the envelope toolbar are both visible.

System_CAPS_pubpropertyExcel4IntlMacroSheets

Gets a Microsoft.Office.Interop.Excel.Sheets collection that represents all the Microsoft Office Excel 4.0 international macro sheets in the workbook.

System_CAPS_pubpropertyExcel4MacroSheets

Gets a Microsoft.Office.Interop.Excel.Sheets collection that represents all the Microsoft Office Excel 4.0 macro sheets in the workbook.

System_CAPS_pubpropertyExcel8CompatibilityMode

Gets a value that indicates whether the workbook is in compatibility mode.

System_CAPS_pubpropertyExtension

Gets a custom extension for this Workbook object.

System_CAPS_pubpropertyFileFormat

Gets the file format and type of the workbook.

System_CAPS_pubpropertyFinal

Gets or sets a value that indicates whether the workbook is final.

System_CAPS_pubpropertyForceFullCalculation

Gets or sets a value that indicates whether to force a full calculation of a workbook.

System_CAPS_pubpropertyFullName

Gets the name of the object, including its path on disk.

System_CAPS_pubpropertyFullNameURLEncoded

Gets the name of the object, including its path on disk.

System_CAPS_pubpropertyHasPassword

Gets a value that indicates whether the workbook has a protection password.

System_CAPS_pubpropertyHasVBProject

Gets a value that indicates whether a workbook has an attached Microsoft Visual Basic for Applications (VBA) project.

System_CAPS_pubpropertyHighlightChangesOnScreen

Gets or sets a value that indicates whether changes to the shared workbook are highlighted on screen.

System_CAPS_pubpropertyHostContext

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

System_CAPS_pubpropertyIconSets

Gets the collection of built-in icon sets that can be used to apply a conditional formatting rule to a range in the workbook.

System_CAPS_pubpropertyInactiveListBorderVisible

Gets or sets a value that indicates whether list borders are visible when a list is not active.

System_CAPS_pubpropertyInnerObject

Gets a Microsoft.Office.Interop.Excel.Workbook that represents the underlying native object for the Workbook.

System_CAPS_pubpropertyIsAddin

Gets or sets a value that indicates whether the workbook is running as an add-in.

System_CAPS_pubpropertyIsInplace

Gets a value that indicates whether the specified workbook is being edited in place.

System_CAPS_pubpropertyItemProvider

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

System_CAPS_pubpropertyKeepChangeHistory

Gets or sets a value that indicates whether change tracking is enabled for the shared workbook.

System_CAPS_pubpropertyListChangesOnNewSheet

Gets or sets a value that indicates whether changes to the shared workbook are shown on a separate worksheet.

System_CAPS_pubpropertyMailer

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

System_CAPS_pubpropertyMultiUserEditing

Gets a value that indicates whether the workbook is open as a shared list.

System_CAPS_pubpropertyName

Gets the name of the workbook.

System_CAPS_pubpropertyNames

Gets a Microsoft.Office.Interop.Excel.Names collection that represents all the names in the workbook (including all worksheet-specific names).

System_CAPS_pubpropertyParent

Gets the parent object for the workbook.

System_CAPS_pubpropertyPassword

Gets or sets the password that must be supplied to open the workbook.

System_CAPS_pubpropertyPasswordEncryptionAlgorithm

Gets the algorithm that Microsoft Office Excel uses to encrypt passwords for the workbook.

System_CAPS_pubpropertyPasswordEncryptionFileProperties

Gets a value that indicates whether Microsoft Office Excel encrypts file properties for the specified password-protected workbook.

System_CAPS_pubpropertyPasswordEncryptionKeyLength

Gets the key length of the algorithm that Microsoft Office Excel uses when encrypting passwords for the workbook.

System_CAPS_pubpropertyPasswordEncryptionProvider

Gets the name of the algorithm encryption provider that Microsoft Office Excel uses when encrypting passwords for the workbook.

System_CAPS_pubpropertyPath

Gets the complete path to the application, excluding the final separator and name of the application.

System_CAPS_pubpropertyPermission

Gets a Microsoft.Office.Core.Permission object that represents the permission settings in the workbook.

System_CAPS_pubpropertyPersonalViewListSettings

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.

System_CAPS_pubpropertyPersonalViewPrintSettings

Gets or sets a value that indicates whether print settings are included in the user's personal view of the shared workbook.

System_CAPS_pubpropertyPrecisionAsDisplayed

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.

System_CAPS_pubpropertyProtectStructure

Gets a value that indicates whether the order of the sheets in the workbook is protected.

System_CAPS_pubpropertyProtectWindows

Gets a value that indicates whether the windows of the workbook are protected.

System_CAPS_pubpropertyPublishObjects
System_CAPS_pubpropertyReadOnly

Gets a value that indicates whether the workbook has been opened as read-only.

System_CAPS_pubpropertyReadOnlyRecommended

Gets or sets a value that indicates whether the workbook was saved as read-only recommended.

System_CAPS_pubpropertyRemovePersonalInformation

Gets or sets a value that indicates whether personal information can be removed from the workbook.

System_CAPS_pubpropertyResearch

Gets an object that represents the research service for the workbook.

System_CAPS_pubpropertyRevisionNumber

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).

System_CAPS_pubpropertySaved

Gets or sets a value that indicates whether no changes have been made to the workbook since it was last saved.

System_CAPS_pubpropertySaveLinkValues

Gets or sets a value that indicates whether Microsoft Office Excel saves external link values with the workbook.

System_CAPS_pubpropertyServerPolicy

Gets an object that represents a policy specified for a workbook that is stored on a server running Microsoft Office SharePoint Server.

System_CAPS_pubpropertyServerViewableItems

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.

System_CAPS_pubpropertySharedWorkspace

Gets a Microsoft.Office.Core.SharedWorkspace that represents the Document Workspace in which the workbook is located.

System_CAPS_pubpropertySheets

Gets a Microsoft.Office.Interop.Excel.Sheets collection that represents all the sheets in the workbook.

System_CAPS_pubpropertyShowConflictHistory

Gets or sets a value that indicates whether the Conflict History worksheet is visible in the workbook that is open as a shared list.

System_CAPS_pubpropertyShowPivotChartActiveFields

Gets or sets a value that indicates whether the PivotChart Filter Pane is visible.

System_CAPS_pubpropertyShowPivotTableFieldList

Gets or sets a value that indicates whether the PivotTable field list can be shown.

System_CAPS_pubpropertySignatures

Gets the collection of digital signatures for the workbook.

System_CAPS_pubpropertySite

(Inherited from IComponent.)

System_CAPS_pubpropertySlicerCaches

Gets the SlicerCaches object associated with the workbook.

System_CAPS_pubpropertySmartDocument

Gets a Microsoft.Office.Core.SmartDocument that represents the settings for a smart document solution.

System_CAPS_pubpropertyStyles

Gets a Microsoft.Office.Interop.Excel.Styles collection that represents all the styles in the workbook.

System_CAPS_pubpropertySync

Gets a Microsoft.Office.Core.Sync object that provides access to the methods and properties of documents that are part of a Document Workspace.

System_CAPS_pubpropertyTableStyles

Gets the collection of table styles that are used in the workbook.

System_CAPS_pubpropertyTag

Gets or sets the object that contains data about the workbook.

System_CAPS_pubpropertyTemplateRemoveExtData

Gets or sets a value that indicates whether external data references are removed when the workbook is saved as a template.

System_CAPS_pubpropertyTheme

Gets the theme that is applied to the workbook.

System_CAPS_pubpropertyUpdateLinks

Gets or sets a value that indicates a workbook's setting for updating embedded OLE links.

System_CAPS_pubpropertyUpdateRemoteReferences

Gets or sets a value that indicates whether Microsoft Office Excel updates remote references in the workbook.

System_CAPS_pubpropertyUserStatus

Gets a 1-based, two-dimensional array that provides information about each user who has the workbook open as a shared list.

System_CAPS_pubpropertyVBASigned

Gets a value that indicates whether the Visual Basic for Applications project for the workbook has been digitally signed.

System_CAPS_pubpropertyVBProject

Gets the virtual Microsoft.Vbe.Interop.VBProject project that is in the workbook.

System_CAPS_pubpropertyVstoSmartTags

Gets the Microsoft.Office.Tools.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.

.

System_CAPS_pubpropertyWebOptions

Gets the Microsoft.Office.Interop.Excel.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.

System_CAPS_pubpropertyWindows

Gets a Microsoft.Office.Interop.Excel.Windows collection that represents all the windows in the workbook.

System_CAPS_pubpropertyWorksheets

Gets a Microsoft.Office.Interop.Excel.Sheets collection that represents all the worksheets in the workbook.

System_CAPS_pubpropertyWritePassword

Gets or sets the write password of a workbook.

System_CAPS_pubpropertyWriteReserved

Gets a value that indicates whether the workbook is write-reserved.

System_CAPS_pubpropertyWriteReservedBy

Gets the name of the user who currently has write permission for the workbook.

System_CAPS_pubpropertyXmlMaps

Gets an Microsoft.Office.Interop.Excel.XmlMaps collection that represents the schema maps that have been added to the workbook.

System_CAPS_pubpropertyXmlNamespaces

Gets an Microsoft.Office.Interop.Excel.XmlNamespaces collection that represents the XML namespaces contained in the workbook.

NameDescription
System_CAPS_pubmethodAcceptAllChanges(Object, Object, Object)

Accepts all changes in the shared workbook.

System_CAPS_pubmethodActivate()

Activates the first window associated with the workbook.

System_CAPS_pubmethodAddToFavorites()

Adds a shortcut to the workbook to the Favorites folder.

System_CAPS_pubmethodApplyTheme(String)

Applies the specified theme to the workbook.

System_CAPS_pubmethodBeginInit()

(Inherited from ISupportInitialize.)

System_CAPS_pubmethodBreakLink(String, XlLinkType)

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

System_CAPS_pubmethodCanCheckIn()

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.

System_CAPS_pubmethodDeleteNumberFormat(String)

Deletes a custom number format from the workbook.

System_CAPS_pubmethodDispose()

(Inherited from IDisposable.)

System_CAPS_pubmethodEnableConnections()

Enables data connections within the workbook.

System_CAPS_pubmethodEndInit()

(Inherited from ISupportInitialize.)

System_CAPS_pubmethodEndReview()

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

System_CAPS_pubmethodExclusiveAccess()

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.

System_CAPS_pubmethodForwardMailer()

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

System_CAPS_pubmethodGetWorkflowTasks()

Returns the collection of workflow tasks for the workbook.

System_CAPS_pubmethodGetWorkflowTemplates()

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.

System_CAPS_pubmethodLinkSources(Object)

Returns an Array of links in the workbook.

System_CAPS_pubmethodLockServerFile()

Locks the workbook on the server to prevent modification.

System_CAPS_pubmethodMergeWorkbook(Object)

Merges changes from one workbook into an open shared workbook.

System_CAPS_pubmethodNewWindow()

Creates a new window.

System_CAPS_pubmethodOpenLinks(String, Object, Object)

Opens the supporting documents for a link or links.

System_CAPS_pubmethodPivotCaches()

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

System_CAPS_pubmethodPost(Object)

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.

System_CAPS_pubmethodPrintPreview(Object)

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.

System_CAPS_pubmethodRefreshAll()

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

System_CAPS_pubmethodRejectAllChanges(Object, Object, Object)

Rejects all changes in the shared workbook.

System_CAPS_pubmethodReloadAs(MsoEncoding)

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

System_CAPS_pubmethodRemoveCustomization()

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

System_CAPS_pubmethodRemoveDocumentInformation(XlRemoveDocInfoType)

Removes all information of the specified type from the workbook.

System_CAPS_pubmethodRemoveUser(Int32)

Disconnects the specified user from the shared workbook.

System_CAPS_pubmethodReply()

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

System_CAPS_pubmethodReplyAll()

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

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

System_CAPS_pubmethodResetColors()

Resets the color palette to the default colors.

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

System_CAPS_pubmethodSave()

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.

System_CAPS_pubmethodSaveCopyAs(Object)

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.

System_CAPS_pubmethodToggleFormsDesign()

Toggles Microsoft Office Excel into and out of design mode.

System_CAPS_pubmethodUnprotect(Object)

Removes protection from the workbook. This method has no effect if the workbook is not protected.

System_CAPS_pubmethodUnprotectSharing(Object)

Turns off protection for sharing and saves the workbook.

System_CAPS_pubmethodUpdateFromFile()

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).

System_CAPS_pubmethodWebPagePreview()

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.

NameDescription
System_CAPS_pubeventActivateEvent

Occurs when the workbook is activated.

System_CAPS_pubeventAddinInstall

Occurs when the workbook is installed as an add-in.

System_CAPS_pubeventAddinUninstall

Occurs when the workbook is uninstalled as an add-in.

System_CAPS_pubeventAfterSave

Occurs after the workbook is saved.

System_CAPS_pubeventAfterXmlExport

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

System_CAPS_pubeventAfterXmlImport

Occurs after an existing XML data connection is refreshed or after new XML data is imported into the workbook.

System_CAPS_pubeventBeforeClose

Occurs before the workbook closes. If the workbook has been changed, this event occurs before the user is asked to save changes.

System_CAPS_pubeventBeforePrint

Occurs before the workbook (or anything in it) is printed.

System_CAPS_pubeventBeforeSave

Occurs before the workbook is saved.

System_CAPS_pubeventBeforeXmlExport

Occurs before Microsoft Office Excel saves or exports data from the workbook to an XML data file.

System_CAPS_pubeventBeforeXmlImport

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

System_CAPS_pubeventBindingContextChanged

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

System_CAPS_pubeventDeactivate

Occurs when the workbook is deactivated.

System_CAPS_pubeventDisposed

(Inherited from IComponent.)

System_CAPS_pubeventNew

Occurs when a new workbook is created.

System_CAPS_pubeventNewChart

Occurs when a new chart is created in the workbook.

System_CAPS_pubeventNewSheet

Occurs when a new sheet is created in the workbook.

System_CAPS_pubeventOpen

Occurs when the workbook is opened.

System_CAPS_pubeventPivotTableCloseConnection

Occurs after a PivotTable report closes the connection to its data source.

System_CAPS_pubeventPivotTableOpenConnection

Occurs after a PivotTable report opens the connection to its data source.

System_CAPS_pubeventRowsetComplete

Occurs when the user navigates through the recordset or invokes the rowset action on an OLAP PivotTable.

System_CAPS_pubeventSheetActivate

Occurs when any sheet is activated.

System_CAPS_pubeventSheetBeforeDoubleClick

Occurs when any worksheet is double-clicked, before the default double-click action.

System_CAPS_pubeventSheetBeforeRightClick

Occurs when any worksheet is right-clicked, before the default right-click action.

System_CAPS_pubeventSheetCalculate

Occurs after any worksheet is recalculated or after any changed data is plotted on a chart.

System_CAPS_pubeventSheetChange

Occurs when cells in any worksheet are changed by the user or by an external link.

System_CAPS_pubeventSheetDeactivate

Occurs when any sheet is deactivated.

System_CAPS_pubeventSheetFollowHyperlink

Occurs when you click any hyperlink in a workbook.

System_CAPS_pubeventSheetPivotTableAfterValueChange

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

System_CAPS_pubeventSheetPivotTableBeforeAllocateChanges

Occurs before changes are applied to a PivotTable.

System_CAPS_pubeventSheetPivotTableBeforeCommitChanges

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

System_CAPS_pubeventSheetPivotTableBeforeDiscardChanges

Occurs before changes to a PivotTable are discarded.

System_CAPS_pubeventSheetPivotTableChangeSync

Occurs after changes to a PivotTable.

System_CAPS_pubeventSheetPivotTableUpdate

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

System_CAPS_pubeventSheetSelectionChange

Occurs when the selection changes on any worksheet. Does not occur if the selection is on a chart sheet.

System_CAPS_pubeventShutdown

Occurs when the workbook host item shuts down.

System_CAPS_pubeventStartup

Occurs after the workbook is running and all the initialization code in the assembly has been run.

System_CAPS_pubeventSyncEvent

Occurs when the local copy of a worksheet that is part of a Document Workspace is synchronized with the copy on the server.

System_CAPS_pubeventWindowActivate

Occurs when any workbook window is activated.

System_CAPS_pubeventWindowDeactivate

Occurs when any workbook window is deactivated.

System_CAPS_pubeventWindowResize

Occurs when any workbook window is resized.

A Microsoft.Office.Tools.Excel.Workbook object provides the same members as a Microsoft.Office.Interop.Excel.Workbook object from the Excel primary interop assembly, but it adds the following features:

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

In document-level projects, you typically do not use Microsoft.Office.Tools.Excel.Workbook objects directly. Instead, use the ThisWorkbook class to programmatically access the workbook in your project. The ThisWorkbook class derives most of its members from the Microsoft.Office.Tools.Excel.WorkbookBase class. This class redirects all calls to its members to an internal implementation of the Microsoft.Office.Tools.Excel.Workbook interface in the Visual Studio Tools for Office runtime. For more information, see Programming Document-Level Customizations.

System_CAPS_noteNote

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 or later. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: http://go.microsoft.com/fwlink/?LinkId=160658.

Return to top
Show: