Workbook Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a Microsoft Excel workbook.
public interface class Workbook : Microsoft::Office::Interop::Excel::_Workbook, Microsoft::Office::Interop::Excel::WorkbookEvents_Event[System.Runtime.InteropServices.Guid("000208DA-0000-0000-C000-000000000046")]
public interface Workbook : Microsoft.Office.Interop.Excel._Workbook, Microsoft.Office.Interop.Excel.WorkbookEvents_EventPublic Interface Workbook
Implements _Workbook, WorkbookEvents_Event- Derived
- Attributes
- Implements
Remarks
This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _Workbook.
The Workbook object is a member of the Workbooks collection. The Workbooks collection contains all the Workbook objects currently open in Microsoft Excel.
The following properties for returning a Workbook object are described in this section:
- Workbooks property
- ActiveWorkbook property
- ThisWorkbook property
Workbooks Property
Use Workbooks(index), where index is the workbook name or index number, to return a single Workbook object.
The index number denotes the order in which the workbooks were opened or created. Workbooks(1) is the first workbook created, and Workbooks(Workbooks.Count) is the last one created. Activating a workbook doesn’t change its index number. All workbooks are included in the index count, even if they’re hidden.
The Name property returns the workbook name. You cannot set the name by using this property; if you need to change the name, use the SaveAs(Object, Object, Object, Object, Object, Object, XlSaveAsAccessMode, Object, Object, Object, Object, Object) method to save the workbook under a different name.
ActiveWorkbook Property
The ActiveWorkbook property returns the workbook that’s currently active.
ThisWorkbook Property
The ThisWorkbook property returns the workbook where the Visual Basic code is running. In most cases, this is the same as the active workbook. However, if the Visual Basic code is part of an add-in, the ThisWorkbook property won’t return the active workbook. In this case, the active workbook is the workbook calling the add-in, so the ThisWorkbook property returns the add-in workbook.
If you’ll be creating an add-in from your Visual Basic code, you should use the ThisWorkbook property to qualify any statement that must be run on the workbook you compile into the add-in.
Properties
| _CodeName |
Reserved for internal use. (Inherited from _Workbook) |
| _ReadOnlyRecommended |
Reserved for internal use. (Inherited from _Workbook) |
| AcceptLabelsInFormulas |
True if labels can be used in worksheet formulas. The default value is False. Read/write Boolean. (Inherited from _Workbook) |
| AccuracyVersion |
Gets or sets whether certain worksheet functions use the latest accuracy algorithms to calculate their results. (Inherited from _Workbook) |
| ActiveChart |
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. (Inherited from _Workbook) |
| ActiveSheet |
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. (Inherited from _Workbook) |
| ActiveSlicer |
Gets an object that represents the active slicer in the active workbook or in the specified workbook. (Inherited from _Workbook) |
| Application |
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. (Inherited from _Workbook) |
| Author |
Returns or sets the author of the comment. Read-only String. (Inherited from _Workbook) |
| AutoUpdateFrequency |
Returns or sets the number of minutes between automatic updates to the shared workbook. Read/write Integer. (Inherited from _Workbook) |
| AutoUpdateSaveChanges |
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. (Inherited from _Workbook) |
| BuiltinDocumentProperties |
Returns a DocumentProperties collection that represents all the built-in document properties for the specified workbook. Read-only. (Inherited from _Workbook) |
| CalculationVersion |
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. (Inherited from _Workbook) |
| CaseSensitive |
True if the workbook distinguishes between upper and lower case when comparing content. Read-only Boolean (bool in C#). (Inherited from _Workbook) |
| ChangeHistoryDuration |
Returns or sets the number of days shown in the shared workbook's change history. Read/write Integer. (Inherited from _Workbook) |
| ChartDataPointTrack |
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. (Inherited from _Workbook) |
| Charts |
Returns a Sheets collection that represents all the chart sheets in the specified workbook. Read-only. (Inherited from _Workbook) |
| CheckCompatibility |
Controls whether or not the compatibility checker is run automatically when the workbook is saved. Read/write. (Inherited from _Workbook) |
| CodeName |
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. (Inherited from _Workbook) |
| Colors[Object] |
Returns or sets colors in the palette for the workbook. The palette has 56 entries, each represented by an RGB value. Read/write Object. (Inherited from _Workbook) |
| CommandBars |
Returns a CommandBars object that represents the Microsoft Excel command bars. Read-only. (Inherited from _Workbook) |
| Comments |
Returns a Comments collection that represents all the comments for the specified worksheet. Read-only. (Inherited from _Workbook) |
| ConflictResolution |
Returns or sets the way conflicts are to be resolved whenever a shared workbook is updated. Read/write XlSaveConflictResolution. (Inherited from _Workbook) |
| Connections |
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. (Inherited from _Workbook) |
| ConnectionsDisabled |
Disables the external connections or links in the workbook. Read-only (Inherited from _Workbook) |
| Container |
Returns the object that represents the container application for the specified OLE object. Read-only Object. (Inherited from _Workbook) |
| ContentTypeProperties |
Returns a MetaProperties collection that describes the metadata stored in the workbook. Read-only. (Inherited from _Workbook) |
| CreateBackup |
True if a backup file is created when this file is saved. Read-only Boolean. (Inherited from _Workbook) |
| Creator |
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. (Inherited from _Workbook) |
| CustomDocumentProperties |
Returns or sets a DocumentProperties collection that represents all the custom document properties for the specified workbook. (Inherited from _Workbook) |
| CustomViews |
Returns a CustomViews collection that represents all the custom views for the workbook. (Inherited from _Workbook) |
| CustomXMLParts |
Returns a. CustomXMLParts collection that represents the custom XML in the XML data store. Read-only. (Inherited from _Workbook) |
| Date1904 |
True if the workbook uses the 1904 date system. Read/write Boolean. (Inherited from _Workbook) |
| DefaultPivotTableStyle |
Specifies the table style from the TableStyles collection that is used as the default style for PivotTables. Read/write. (Inherited from _Workbook) |
| DefaultSlicerStyle |
Gets or sets the style from the TableStyles object that is used as the default style for slicers. (Inherited from _Workbook) |
| DefaultTableStyle |
Specifies the table style from the TableStyles collection that is used as the default TableStyle. Read/write (Inherited from _Workbook) |
| DefaultTimelineStyle |
The name of the default slicer style of the workbook. Object (object in C#). Read/Write (Inherited from _Workbook) |
| DialogSheets |
Reserved for internal use. (Inherited from _Workbook) |
| DisplayDrawingObjects |
Returns or sets how shapes are displayed. Read/write XlDisplayDrawingObjects. (Inherited from _Workbook) |
| DisplayInkComments |
A Boolean value that determines whether ink comments are displayed in the workbook. Read/write Boolean. (Inherited from _Workbook) |
| DocumentInspectors |
Returns a DocumentInspectors collection that represents the Document Inspector modules for the specified workbook. Read-only. (Inherited from _Workbook) |
| DocumentLibraryVersions |
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. (Inherited from _Workbook) |
| DoNotPromptForConvert |
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 (Inherited from _Workbook) |
| EnableAutoRecover |
Saves changed files, of all formats, on a timed interval. Read/write Boolean. (Inherited from _Workbook) |
| EncryptionProvider |
Returns a String specifying the name of the algorithm encryption provider that 1st_Excel12 uses when encrypting documents. Read/write. (Inherited from _Workbook) |
| EnvelopeVisible |
True if the e-mail composition header and the envelope toolbar are both visible. Read/write Boolean. (Inherited from _Workbook) |
| Excel4IntlMacroSheets |
Returns a Sheets collection that represents all the Microsoft Excel 4.0 international macro sheets in the specified workbook. Read-only. (Inherited from _Workbook) |
| Excel4MacroSheets |
Returns a Sheets collection that represents all the Microsoft Excel 4.0 macro sheets in the specified workbook. Read-only. (Inherited from _Workbook) |
| Excel8CompatibilityMode |
The Excel8CompatibilityMode property provides developers with a way to check if the workbook is in compatibility mode. Read-only (Inherited from _Workbook) |
| FileFormat |
Returns the file format and/or type of the workbook. Read-only XlFileFormat. (Inherited from _Workbook) |
| Final |
Returns or sets a Boolean that indicates whether a workbook is final. Read/write (Inherited from _Workbook) |
| ForceFullCalculation |
Forces a full calculation of a workbook. Read/write. (Inherited from _Workbook) |
| FullName |
Returns the name of the object, including its path on disk, as a string. Read-only String. (Inherited from _Workbook) |
| FullNameURLEncoded |
Returns a String indicating the name of the object, including its path on disk, as a string. Read-only. (Inherited from _Workbook) |
| HasMailer |
Reserved for internal use. (Inherited from _Workbook) |
| HasPassword |
True if the workbook has a protection password. Read-only Boolean. (Inherited from _Workbook) |
| HasRoutingSlip |
True if the workbook has a routing slip. Read/write Boolean. (Inherited from _Workbook) |
| HasVBProject |
Returns a Boolean that represents whether a workbook has an attached Microsoft Visual Basic for Applications project. Read-only. (Inherited from _Workbook) |
| HighlightChangesOnScreen |
True if changes to the shared workbook are highlighted on-screen. Read/write Boolean. (Inherited from _Workbook) |
| HTMLProject |
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. (Inherited from _Workbook) |
| IconSets |
This property is used to filter data in a workbook based on a cell icon from the IconSets collection. Read-only. (Inherited from _Workbook) |
| InactiveListBorderVisible |
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. (Inherited from _Workbook) |
| IsAddin |
True if the workbook is running as an add-in. Read/write Boolean. (Inherited from _Workbook) |
| IsInplace |
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. (Inherited from _Workbook) |
| KeepChangeHistory |
True if change tracking is enabled for the shared workbook. Read/write Boolean. (Inherited from _Workbook) |
| Keywords |
Reserved for internal use. (Inherited from _Workbook) |
| ListChangesOnNewSheet |
True if changes to the shared workbook are shown on a separate worksheet. Read/write Boolean. (Inherited from _Workbook) |
| Mailer |
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. (Inherited from _Workbook) |
| Model |
Returns the top level Model object which is the one Data Model for the workbook. Read-only (Inherited from _Workbook) |
| Modules |
Reserved for internal use. (Inherited from _Workbook) |
| MultiUserEditing |
True if the workbook is open as a shared list. Read-only Boolean. (Inherited from _Workbook) |
| Name |
Returns the name of the object. Read-only String. (Inherited from _Workbook) |
| Names |
Returns a Names collection that represents all the names in the specified workbook (including all worksheet-specific names). Read-only Names object. (Inherited from _Workbook) |
| OnSave |
Reserved for internal use. (Inherited from _Workbook) |
| OnSheetActivate |
Reserved for internal use. (Inherited from _Workbook) |
| OnSheetDeactivate |
Reserved for internal use. (Inherited from _Workbook) |
| Parent |
Returns the parent object for the specified object. Read-only. (Inherited from _Workbook) |
| Password |
Returns or sets the password that must be supplied to open the specified workbook. Read/write String. (Inherited from _Workbook) |
| PasswordEncryptionAlgorithm |
Returns a String indicating the algorithm Microsoft Excel uses to encrypt passwords for the specified workbook. Read-only. (Inherited from _Workbook) |
| PasswordEncryptionFileProperties |
True if Microsoft Excel encrypts file properties for the specified password-protected workbook. Read-only Boolean. (Inherited from _Workbook) |
| PasswordEncryptionKeyLength |
Returns an Integer indicating the key length of the algorithm Microsoft Excel uses when encrypting passwords for the specified workbook. Read-only. (Inherited from _Workbook) |
| PasswordEncryptionProvider |
Returns a String specifying the name of the algorithm encryption provider that Microsoft Excel uses when encrypting passwords for the specified workbook. Read-only. (Inherited from _Workbook) |
| Path |
Returns the complete path to the application, excluding the final separator and name of the application. Read-only String. (Inherited from _Workbook) |
| Permission |
Returns a Permission object that represents the permission settings in the specified workbook. (Inherited from _Workbook) |
| PersonalViewListSettings |
True if filter and sort settings for lists are included in the user's personal view of the shared workbook. Read/write Boolean. (Inherited from _Workbook) |
| PersonalViewPrintSettings |
True if print settings are included in the user's personal view of the shared workbook. Read-write Boolean. (Inherited from _Workbook) |
| PivotTables |
Returns an object that represents a collection of all the PivotTable reports on a worksheet. Read-only. (Inherited from _Workbook) |
| PrecisionAsDisplayed |
True if calculations in this workbook will be done using only the precision of the numbers as they’re displayed. Read/write Boolean. (Inherited from _Workbook) |
| ProtectStructure |
True if the order of the sheets in the workbook is protected. Read-only Boolean. (Inherited from _Workbook) |
| ProtectWindows |
True if the windows of the workbook are protected. Read-only Boolean. (Inherited from _Workbook) |
| PublishObjects |
Returns the PublishObjects collection. Read-only. (Inherited from _Workbook) |
| ReadOnly |
Returns True if the object has been opened as read-only. Read-only Boolean. (Inherited from _Workbook) |
| ReadOnlyRecommended |
True if the workbook was saved as read-only recommended. Read-only Boolean. (Inherited from _Workbook) |
| RemovePersonalInformation |
True if personal information can be removed from the specified workbook. The default value is False. Read/write Boolean. (Inherited from _Workbook) |
| Research |
Returns a Research object that represents the research service for a workbook. Read-only. (Inherited from _Workbook) |
| RevisionNumber |
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. (Inherited from _Workbook) |
| Routed |
True if the workbook has been routed to the next recipient. False if the workbook needs to be routed. Read-only Boolean. (Inherited from _Workbook) |
| RoutingSlip |
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. (Inherited from _Workbook) |
| Saved |
True if no changes have been made to the specified workbook since it was last saved. Read/write Boolean. (Inherited from _Workbook) |
| SaveLinkValues |
True if Microsoft Excel saves external link values with the workbook. Read/write Boolean. (Inherited from _Workbook) |
| ServerPolicy |
Returns a ServerPolicy object that represents a policy specified for a workbook stored on a server running 2nd_OSS_NoVersion 2007. Read-only. (Inherited from _Workbook) |
| ServerViewableItems |
Allows a developer to interact with the list of published objects in the workbook that are shown on the server. Read-only. (Inherited from _Workbook) |
| SharedWorkspace |
Returns a SharedWorkspace object that represents the Document Workspace in which a specified document is located. Read-only. (Inherited from _Workbook) |
| Sheets |
Returns a Sheets collection that represents all the sheets in the specified workbook. Read-only Sheets object. (Inherited from _Workbook) |
| ShowConflictHistory |
True if the Conflict History worksheet is visible in the workbook that's open as a shared list. Read/write Boolean. (Inherited from _Workbook) |
| ShowPivotChartActiveFields |
This property controls the visibility of the PivotChart Filter Pane. Read/write. (Inherited from _Workbook) |
| ShowPivotTableFieldList |
True (default) if the PivotTable field list can be shown. Read/write Boolean. (Inherited from _Workbook) |
| Signatures |
Returns the digital signatures for a workbook. Read-only. (Inherited from _Workbook) |
| SlicerCaches |
Gets the SlicerCaches object associated with the workbook. (Inherited from _Workbook) |
| SmartDocument |
Returns a SmartDocument object that represents the settings for a smart document solution. Read-only. (Inherited from _Workbook) |
| SmartTagOptions |
Returns a SmartTagOptions object representing the options that can be performed with a smart tag. (Inherited from _Workbook) |
| Styles |
Returns a Styles collection that represents all the styles in the specified workbook. Read-only. (Inherited from _Workbook) |
| Subject |
Reserved for internal use. (Inherited from _Workbook) |
| TableStyles |
Returns a TableStyles collection object for the current workbook that refers to the styles used in the current workbook. Read-only. (Inherited from _Workbook) |
| TemplateRemoveExtData |
True if external data references are removed when the workbook is saved as a template. Read/write Boolean. (Inherited from _Workbook) |
| Theme |
Returns the theme applied to the current workbook. Read-only. (Inherited from _Workbook) |
| Title |
Reserved for internal use. (Inherited from _Workbook) |
| UpdateLinks |
Returns or sets an XlUpdateLinks constant indicating a workbook's setting for updating embedded OLE links. Read/write. (Inherited from _Workbook) |
| UpdateRemoteReferences |
True if Microsoft Excel updates remote references in the workbook. Read/write Boolean. (Inherited from _Workbook) |
| UserControl |
Reserved for internal use. (Inherited from _Workbook) |
| UserStatus |
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. (Inherited from _Workbook) |
| UseWholeCellCriteria |
True if the workbook uses search patterns that match the entire content of a cell. Read-only Boolean (bool in C#). (Inherited from _Workbook) |
| UseWildcards |
True if the workbook enables wildcards for character string comparisons and searching. Read-only Boolean (bool in C#). (Inherited from _Workbook) |
| VBASigned |
True if the Visual Basic for Applications project for the specified workbook has been digitally signed. Read-only Boolean. (Inherited from _Workbook) |
| VBProject |
Returns a VBProject object that represents the Visual Basic project in the specified workbook. Read-only. (Inherited from _Workbook) |
| WebOptions |
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. (Inherited from _Workbook) |
| Windows |
Returns a Windows collection that represents all the windows in the specified workbook. Read-only Windows object. (Inherited from _Workbook) |
| Worksheets |
Returns a Sheets collection that represents all the worksheets in the specified workbook. Read-only Sheets object. (Inherited from _Workbook) |
| WritePassword |
Returns or sets a String for the write password of a workbook. Read/write. (Inherited from _Workbook) |
| WriteReserved |
True if the workbook is write-reserved. Read-only Boolean. (Inherited from _Workbook) |
| WriteReservedBy |
Returns the name of the user who currently has write permission for the workbook. Read-only String. (Inherited from _Workbook) |
| XmlMaps |
Returns an XmlMaps collection that represents the schema maps that have been added to the specified workbook. Read-only. (Inherited from _Workbook) |
| XmlNamespaces |
Returns an XmlNamespaces collection that represents the XML namespaces contained in the specified workbook. Read-only. (Inherited from _Workbook) |
Methods
| _PrintOut(Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Workbook) |
| _Protect(Object, Object, Object) |
Reserved for internal use. (Inherited from _Workbook) |
| _SaveAs(Object, Object, Object, Object, Object, Object, XlSaveAsAccessMode, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Workbook) |
| AcceptAllChanges(Object, Object, Object) |
Accepts all changes in the specified shared workbook. (Inherited from _Workbook) |
| AddToFavorites() |
Adds a shortcut to the workbook or a hyperlink to the Favorites folder. (Inherited from _Workbook) |
| ApplyTheme(String) |
Applies the specified theme to the current workbook. (Inherited from _Workbook) |
| BreakLink(String, XlLinkType) |
Converts formulas linked to other Microsoft Excel sources or OLE sources to values. (Inherited from _Workbook) |
| CanCheckIn() |
True if Microsoft Excel can check in a specified workbook to a server. (Inherited from _Workbook) |
| ChangeFileAccess(XlFileAccess, Object, Object) |
Changes the access permissions for the workbook. This may require an updated version to be loaded from the disk. (Inherited from _Workbook) |
| ChangeLink(String, String, XlLinkType) |
Changes a link from one document to another. (Inherited from _Workbook) |
| 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 will also close the workbook. (Inherited from _Workbook) |
| CheckInWithVersion(Object, Object, Object, Object) |
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. (Inherited from _Workbook) |
| Close(Object, Object, Object) |
Closes the object. (Inherited from _Workbook) |
| DeleteNumberFormat(String) |
Deletes a custom number format from the workbook. (Inherited from _Workbook) |
| Dummy16() |
Reserved for internal use. (Inherited from _Workbook) |
| Dummy17(Int32) |
Reserved for internal use. (Inherited from _Workbook) |
| Dummy26() | (Inherited from _Workbook) |
| Dummy27() | (Inherited from _Workbook) |
| EnableConnections() |
The EnableConnections() method allows developers to programmatically enable data connections within the workbook for the user. (Inherited from _Workbook) |
| EndReview() |
Terminates a review of a file that has been sent for review using the SendForReview(Object, Object, Object, Object) method. (Inherited from _Workbook) |
| ExclusiveAccess() |
Assigns the current user exclusive access to the workbook that's open as a shared list. (Inherited from _Workbook) |
| ExportAsFixedFormat(XlFixedFormatType, Object, Object, Object, Object, Object, Object, Object, Object) |
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. (Inherited from _Workbook) |
| FollowHyperlink(String, Object, Object, Object, Object, Object, Object) |
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. (Inherited from _Workbook) |
| ForwardMailer() |
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. (Inherited from _Workbook) |
| GetWorkflowTasks() |
Returns the collection of WorkflowTask objects for the specified workbook. (Inherited from _Workbook) |
| GetWorkflowTemplates() |
Returns the collection of WorkflowTemplate objects for the specified workbook. (Inherited from _Workbook) |
| HighlightChangesOptions(Object, Object, Object) |
Controls how changes are shown in a shared workbook. (Inherited from _Workbook) |
| LinkInfo(String, XlLinkInfo, Object, Object) |
Returns the link date and update status. Object. (Inherited from _Workbook) |
| LinkSources(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. (Inherited from _Workbook) |
| LockServerFile() |
Locks the workbook on the server to prevent modification. (Inherited from _Workbook) |
| MergeWorkbook(Object) |
Merges changes from one workbook into an open workbook. (Inherited from _Workbook) |
| NewWindow() |
Creates a new window or a copy of the specified window. (Inherited from _Workbook) |
| OpenLinks(String, Object, Object) |
Opens the supporting documents for a link or links. (Inherited from _Workbook) |
| PivotCaches() |
Returns a PivotCaches collection that represents all the PivotTable caches in the specified workbook. Read-only. (Inherited from _Workbook) |
| PivotTableWizard(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Workbook) |
| Post(Object) |
Posts the specified workbook to a public folder. This method works only with a Microsoft Exchange client connected to a Microsoft Exchange server. (Inherited from _Workbook) |
| PrintOut(Object, Object, Object, Object, Object, Object, Object, Object) |
Prints the object. (Inherited from _Workbook) |
| PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Workbook) |
| PrintPreview(Object) |
Shows a preview of the object as it would look when printed. (Inherited from _Workbook) |
| Protect(Object, Object, Object) |
Protects a workbook so that it cannot be modified. (Inherited from _Workbook) |
| ProtectSharing(Object, Object, Object, Object, Object, Object) |
Saves the workbook and protects it for sharing. (Inherited from _Workbook) |
| ProtectSharingEx(Object, Object, Object, Object, Object, Object, Object) |
Reserved for internal use. (Inherited from _Workbook) |
| PurgeChangeHistoryNow(Int32, Object) |
Removes entries from the change log for the specified workbook. (Inherited from _Workbook) |
| RecheckSmartTags() |
Causes a foreground smart tag check to occur, automatically annotating data that was not annotated before. (Inherited from _Workbook) |
| RefreshAll() |
Refreshes all external data ranges and PivotTable reports in the specified workbook. (Inherited from _Workbook) |
| RejectAllChanges(Object, Object, Object) |
Rejects all changes in the specified shared workbook. (Inherited from _Workbook) |
| ReloadAs(MsoEncoding) |
Reloads a workbook based on an HTML document, using the specified document encoding. (Inherited from _Workbook) |
| RemoveDocumentInformation(XlRemoveDocInfoType) |
Removes all information of the specified type from the workbook. (Inherited from _Workbook) |
| RemoveUser(Int32) |
Disconnects the specified user from the shared workbook. (Inherited from _Workbook) |
| Reply() |
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. (Inherited from _Workbook) |
| ReplyAll() |
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. (Inherited from _Workbook) |
| ReplyWithChanges(Object) |
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. (Inherited from _Workbook) |
| ResetColors() |
Resets the color palette to the default colors. (Inherited from _Workbook) |
| Route() |
Routes the workbook, using the workbook's current routing slip. (Inherited from _Workbook) |
| 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. (Inherited from _Workbook) |
| Save() |
Saves changes to the specified workbook. (Inherited from _Workbook) |
| SaveAs(Object, Object, Object, Object, Object, Object, XlSaveAsAccessMode, Object, Object, Object, Object, Object) |
Saves changes to the workbook in a different file. (Inherited from _Workbook) |
| SaveAsXMLData(String, XmlMap) |
Exports the data that has been mapped to the specified XML schema map to an XML data file. (Inherited from _Workbook) |
| SaveCopyAs(Object) |
Saves a copy of the workbook to a file but doesn't modify the open workbook in memory. (Inherited from _Workbook) |
| sblt(String) |
Reserved for internal use. (Inherited from _Workbook) |
| SendFaxOverInternet(Object, Object, Object) |
Sends a worksheet as a fax to the specified recipients. (Inherited from _Workbook) |
| SendForReview(Object, Object, Object, Object) |
Sends a workbook in an e-mail message for review to the specified recipients. (Inherited from _Workbook) |
| SendMail(Object, Object, Object) |
Sends the workbook by using the installed mail system. (Inherited from _Workbook) |
| SendMailer(Object, XlPriority) |
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. (Inherited from _Workbook) |
| SetLinkOnData(String, Object) |
Sets the name of a procedure that runs whenever a DDE link is updated. (Inherited from _Workbook) |
| SetPasswordEncryptionOptions(Object, Object, Object, Object) |
Sets the options for encrypting workbooks using passwords. (Inherited from _Workbook) |
| ToggleFormsDesign() |
Toggles form design mode on or off. (Inherited from _Workbook) |
| Unprotect(Object) |
Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected. (Inherited from _Workbook) |
| UnprotectSharing(Object) |
Turns off protection for sharing and saves the workbook. (Inherited from _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 hasn't changed since the workbook was loaded, the in-memory copy of the workbook isn't reloaded. (Inherited from _Workbook) |
| UpdateLink(Object, Object) |
Updates a Microsoft Excel, DDE, or OLE link (or links). (Inherited from _Workbook) |
| WebPagePreview() |
Displays a preview of the specified workbook as it would look if saved as a Web page. (Inherited from _Workbook) |
| XmlImport(String, XmlMap, Object, Object) |
Imports an XML data file into the current workbook. Returns XlXmlImportResult. (Inherited from _Workbook) |
| XmlImportXml(String, XmlMap, Object, Object) |
Imports an XML data stream that has been previously loaded into memory. Returns XlXmlImportResult. (Inherited from _Workbook) |
Events
| Activate |
Occurs when a workbook is activated. (Inherited from WorkbookEvents_Event) |
| AddinInstall |
Occurs when the workbook is installed as an add-in. (Inherited from WorkbookEvents_Event) |
| AddinUninstall |
Occurs when the workbook is uninstalled as an add-in. (Inherited from WorkbookEvents_Event) |
| AfterSave |
Occurs after the workbook is saved. (Inherited from WorkbookEvents_Event) |
| AfterXmlExport |
Occurs after Excel saves or exports data from the specified workbook to an XML data file. (Inherited from WorkbookEvents_Event) |
| AfterXmlImport |
Occurs after an existing XML data connection is refreshed or after new XML data is imported into the specified Excel workbook. (Inherited from WorkbookEvents_Event) |
| BeforeClose |
Occurs before the workbook closes. If the workbook has been changed, this event occurs before the user is asked to save changes. (Inherited from WorkbookEvents_Event) |
| BeforePrint |
Occurs before the workbook (or anything in it) is printed. (Inherited from WorkbookEvents_Event) |
| BeforeSave |
Occurs before the workbook is saved. (Inherited from WorkbookEvents_Event) |
| BeforeXmlExport |
Occurs before Excel saves or exports data from the specified workbook to an XML data file. (Inherited from WorkbookEvents_Event) |
| BeforeXmlImport |
Occurs before an existing XML data connection is refreshed or before new XML data is imported into an Excel workbook. (Inherited from WorkbookEvents_Event) |
| Deactivate |
Occurs when the workbook is deactivated. (Inherited from WorkbookEvents_Event) |
| ModelChange |
Occurs after the Excel data model is changed. (Inherited from WorkbookEvents_Event) |
| NewChart |
Occurs when a new chart is created in the workbook. (Inherited from WorkbookEvents_Event) |
| NewSheet |
Occurs when a new sheet is created in the workbook. (Inherited from WorkbookEvents_Event) |
| Open |
Occurs when the workbook is opened. (Inherited from WorkbookEvents_Event) |
| PivotTableCloseConnection |
Occurs after a PivotTable report closes the connection to its data source. (Inherited from WorkbookEvents_Event) |
| PivotTableOpenConnection |
Occurs after a PivotTable report opens the connection to its data source. (Inherited from WorkbookEvents_Event) |
| RowsetComplete |
The event is raised when the user either drills through the recordset or invokes the rowset action on an OLAP PivotTable. (Inherited from WorkbookEvents_Event) |
| SheetActivate |
Occurs when any sheet is activated. (Inherited from WorkbookEvents_Event) |
| SheetBeforeDelete |
Occurs before the worksheet is deleted. (Inherited from WorkbookEvents_Event) |
| SheetBeforeDoubleClick |
Occurs when any worksheet is double-clicked, before the default double-click action. (Inherited from WorkbookEvents_Event) |
| SheetBeforeRightClick |
Occurs when any worksheet is right-clicked, before the default right-click action. (Inherited from WorkbookEvents_Event) |
| SheetCalculate |
Occurs after any worksheet is recalculated or after any changed data is plotted on a chart. (Inherited from WorkbookEvents_Event) |
| SheetChange |
Occurs when cells in any worksheet are changed by the user or by an external link. (Inherited from WorkbookEvents_Event) |
| SheetDeactivate |
Occurs when any sheet is deactivated. (Inherited from WorkbookEvents_Event) |
| SheetFollowHyperlink |
Occurs when you click any hyperlink in Microsoft Excel. (Inherited from WorkbookEvents_Event) |
| SheetLensGalleryRenderComplete |
Occurs when a callout gallery’s icons (dynamic and static) have completed rendering for a worksheet. (Inherited from WorkbookEvents_Event) |
| SheetPivotTableAfterValueChange |
Occurs after a cell or range of cells inside a PivotTable are edited or recalculated (for cells that contain formulas). (Inherited from WorkbookEvents_Event) |
| SheetPivotTableBeforeAllocateChanges |
Occurs before changes are applied to a PivotTable. (Inherited from WorkbookEvents_Event) |
| SheetPivotTableBeforeCommitChanges |
Occurs before changes are committed against the OLAP data source for a PivotTable. (Inherited from WorkbookEvents_Event) |
| SheetPivotTableBeforeDiscardChanges |
Occurs before changes to a PivotTable are discarded. (Inherited from WorkbookEvents_Event) |
| SheetPivotTableChangeSync |
Occurs after changes to a PivotTable. (Inherited from WorkbookEvents_Event) |
| SheetPivotTableUpdate |
Occurs after the sheet of the PivotTable report has been updated. (Inherited from WorkbookEvents_Event) |
| SheetSelectionChange |
Occurs when the selection changes on any worksheet (doesn't occur if the selection is on a chart sheet). (Inherited from WorkbookEvents_Event) |
| SheetTableUpdate |
Occurs after the sheet table has been updated. (Inherited from WorkbookEvents_Event) |
| Sync |
Occurs when the local copy of a worksheet that is part of a Document Workspace is synchronized with the copy on the server. (Inherited from WorkbookEvents_Event) |
| WindowActivate |
Occurs when any workbook window is activated. (Inherited from WorkbookEvents_Event) |
| WindowDeactivate |
Occurs when any workbook window is deactivated. (Inherited from WorkbookEvents_Event) |
| WindowResize |
Occurs when any workbook window is resized. (Inherited from WorkbookEvents_Event) |