_Workbook Interface

Reference

Definition

Namespace:: Microsoft.Office.Interop.Excel

Assembly:: Microsoft.Office.Interop.Excel.dll

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.

This is a primary interface in a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this primary interface only when the method you want to use shares the same name as an event of the COM object; in this case, cast to this interface to call the method, and cast to the latest events interface to connect to the event. Otherwise, use the .NET interface that is derived from the COM coclass to access methods, properties, and events of the COM object. For more information about the COM object, see Workbook.

public interface class _Workbook

[System.Runtime.InteropServices.Guid("000208DA-0000-0000-C000-000000000046")]
public interface _Workbook

Public Interface _Workbook

Derived: Microsoft.Office.Interop.Excel.Workbook

Attributes: GuidAttribute

Properties

_CodeName	Reserved for internal use.
_ReadOnlyRecommended	Reserved for internal use.
AcceptLabelsInFormulas	True if labels can be used in worksheet formulas. The default value is False. Read/write Boolean.
AccuracyVersion	Gets or sets whether certain worksheet functions use the latest accuracy algorithms to calculate their results.
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.
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.
ActiveSlicer	Gets an object that represents the active slicer in the active workbook or in the specified 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.
Author	Returns or sets the author of the comment. Read-only String.
AutoUpdateFrequency	Returns or sets the number of minutes between automatic updates to the shared workbook. Read/write Integer.
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.
BuiltinDocumentProperties	Returns a DocumentProperties collection that represents all the built-in document properties for the specified workbook. Read-only.
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.
CaseSensitive	True if the workbook distinguishes between upper and lower case when comparing content. Read-only Boolean (bool in C#).
ChangeHistoryDuration	Returns or sets the number of days shown in the shared workbook's change history. Read/write Integer.
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.
Charts	Returns a Sheets collection that represents all the chart sheets in the specified workbook. Read-only.
CheckCompatibility	Controls whether or not the compatibility checker is run automatically when the workbook is saved. Read/write.
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.
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.
CommandBars	Returns a CommandBars object that represents the Microsoft Excel command bars. Read-only.
Comments	Returns a Comments collection that represents all the comments for the specified worksheet. Read-only.
ConflictResolution	Returns or sets the way conflicts are to be resolved whenever a shared workbook is updated. Read/write XlSaveConflictResolution.
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.
ConnectionsDisabled	Disables the external connections or links in the workbook. Read-only
Container	Returns the object that represents the container application for the specified OLE object. Read-only Object.
ContentTypeProperties	Returns a MetaProperties collection that describes the metadata stored in the workbook. Read-only.
CreateBackup	True if a backup file is created when this file is saved. Read-only Boolean.
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.
CustomDocumentProperties	Returns or sets a DocumentProperties collection that represents all the custom document properties for the specified workbook.
CustomViews	Returns a CustomViews collection that represents all the custom views for the workbook.
CustomXMLParts	Returns a. CustomXMLParts collection that represents the custom XML in the XML data store. Read-only.
Date1904	True if the workbook uses the 1904 date system. Read/write Boolean.
DefaultPivotTableStyle	Specifies the table style from the TableStyles collection that is used as the default style for PivotTables. Read/write.
DefaultSlicerStyle	Gets or sets the style from the TableStyles object that is used as the default style for slicers.
DefaultTableStyle	Specifies the table style from the TableStyles collection that is used as the default TableStyle. Read/write
DefaultTimelineStyle	The name of the default slicer style of the workbook. Object (object in C#). Read/Write
DialogSheets	Reserved for internal use.
DisplayDrawingObjects	Returns or sets how shapes are displayed. Read/write XlDisplayDrawingObjects.
DisplayInkComments	A Boolean value that determines whether ink comments are displayed in the workbook. Read/write Boolean.
DocumentInspectors	Returns a DocumentInspectors collection that represents the Document Inspector modules for the specified workbook. Read-only.
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.
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
EnableAutoRecover	Saves changed files, of all formats, on a timed interval. Read/write Boolean.
EncryptionProvider	Returns a String specifying the name of the algorithm encryption provider that 1st_Excel12 uses when encrypting documents. Read/write.
EnvelopeVisible	True if the e-mail composition header and the envelope toolbar are both visible. Read/write Boolean.
Excel4IntlMacroSheets	Returns a Sheets collection that represents all the Microsoft Excel 4.0 international macro sheets in the specified workbook. Read-only.
Excel4MacroSheets	Returns a Sheets collection that represents all the Microsoft Excel 4.0 macro sheets in the specified workbook. Read-only.
Excel8CompatibilityMode	The Excel8CompatibilityMode property provides developers with a way to check if the workbook is in compatibility mode. Read-only
FileFormat	Returns the file format and/or type of the workbook. Read-only XlFileFormat.
Final	Returns or sets a Boolean that indicates whether a workbook is final. Read/write
ForceFullCalculation	Forces a full calculation of a workbook. Read/write.
FullName	Returns the name of the object, including its path on disk, as a string. Read-only String.
FullNameURLEncoded	Returns a String indicating the name of the object, including its path on disk, as a string. Read-only.
HasMailer	Reserved for internal use.
HasPassword	True if the workbook has a protection password. Read-only Boolean.
HasRoutingSlip	True if the workbook has a routing slip. Read/write Boolean.
HasVBProject	Returns a Boolean that represents whether a workbook has an attached Microsoft Visual Basic for Applications project. Read-only.
HighlightChangesOnScreen	True if changes to the shared workbook are highlighted on-screen. Read/write Boolean.
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.
IconSets	This property is used to filter data in a workbook based on a cell icon from the IconSets collection. Read-only.
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.
IsAddin	True if the workbook is running as an add-in. Read/write Boolean.
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.
KeepChangeHistory	True if change tracking is enabled for the shared workbook. Read/write Boolean.
Keywords	Reserved for internal use.
ListChangesOnNewSheet	True if changes to the shared workbook are shown on a separate worksheet. Read/write Boolean.
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.
Model	Returns the top level Model object which is the one Data Model for the workbook. Read-only
Modules	Reserved for internal use.
MultiUserEditing	True if the workbook is open as a shared list. Read-only Boolean.
Name	Returns the name of the object. Read-only String.
Names	Returns a Names collection that represents all the names in the specified workbook (including all worksheet-specific names). Read-only Names object.
OnSave	Reserved for internal use.
OnSheetActivate	Reserved for internal use.
OnSheetDeactivate	Reserved for internal use.
Parent	Returns the parent object for the specified object. Read-only.
Password	Returns or sets the password that must be supplied to open the specified workbook. Read/write String.
PasswordEncryptionAlgorithm	Returns a String indicating the algorithm Microsoft Excel uses to encrypt passwords for the specified workbook. Read-only.
PasswordEncryptionFileProperties	True if Microsoft Excel encrypts file properties for the specified password-protected workbook. Read-only Boolean.
PasswordEncryptionKeyLength	Returns an Integer indicating the key length of the algorithm Microsoft Excel uses when encrypting passwords for the specified workbook. Read-only.
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.
Path	Returns the complete path to the application, excluding the final separator and name of the application. Read-only String.
Permission	Returns a Permission object that represents the permission settings in the specified 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.
PersonalViewPrintSettings	True if print settings are included in the user's personal view of the shared workbook. Read-write Boolean.
PivotTables	Returns an object that represents a collection of all the PivotTable reports on a worksheet. Read-only.
PrecisionAsDisplayed	True if calculations in this workbook will be done using only the precision of the numbers as they’re displayed. Read/write Boolean.
ProtectStructure	True if the order of the sheets in the workbook is protected. Read-only Boolean.
ProtectWindows	True if the windows of the workbook are protected. Read-only Boolean.
PublishObjects	Returns the PublishObjects collection. Read-only.
ReadOnly	Returns True if the object has been opened as read-only. Read-only Boolean.
ReadOnlyRecommended	True if the workbook was saved as read-only recommended. Read-only Boolean.
RemovePersonalInformation	True if personal information can be removed from the specified workbook. The default value is False. Read/write Boolean.
Research	Returns a Research object that represents the research service for a workbook. Read-only.
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.
Routed	True if the workbook has been routed to the next recipient. False if the workbook needs to be routed. Read-only Boolean.
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.
Saved	True if no changes have been made to the specified workbook since it was last saved. Read/write Boolean.
SaveLinkValues	True if Microsoft Excel saves external link values with the workbook. Read/write Boolean.
ServerPolicy	Returns a ServerPolicy object that represents a policy specified for a workbook stored on a server running 2nd_OSS_NoVersion 2007. Read-only.
ServerViewableItems	Allows a developer to interact with the list of published objects in the workbook that are shown on the server. Read-only.
SharedWorkspace	Returns a SharedWorkspace object that represents the Document Workspace in which a specified document is located. Read-only.
Sheets	Returns a Sheets collection that represents all the sheets in the specified workbook. Read-only Sheets object.
ShowConflictHistory	True if the Conflict History worksheet is visible in the workbook that's open as a shared list. Read/write Boolean.
ShowPivotChartActiveFields	This property controls the visibility of the PivotChart Filter Pane. Read/write.
ShowPivotTableFieldList	True (default) if the PivotTable field list can be shown. Read/write Boolean.
Signatures	Returns the digital signatures for a workbook. Read-only.
SlicerCaches	Gets the SlicerCaches object associated with the workbook.
SmartDocument	Returns a SmartDocument object that represents the settings for a smart document solution. Read-only.
SmartTagOptions	Returns a SmartTagOptions object representing the options that can be performed with a smart tag.
Styles	Returns a Styles collection that represents all the styles in the specified workbook. Read-only.
Subject	Reserved for internal use.
Sync	Returns a Sync object that provides access to the methods and properties for documents that are part of a Document Workspace.
TableStyles	Returns a TableStyles collection object for the current workbook that refers to the styles used in the current workbook. Read-only.
TemplateRemoveExtData	True if external data references are removed when the workbook is saved as a template. Read/write Boolean.
Theme	Returns the theme applied to the current workbook. Read-only.
Title	Reserved for internal use.
UpdateLinks	Returns or sets an XlUpdateLinks constant indicating a workbook's setting for updating embedded OLE links. Read/write.
UpdateRemoteReferences	True if Microsoft Excel updates remote references in the workbook. Read/write Boolean.
UserControl	Reserved for internal use.
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.
UseWholeCellCriteria	True if the workbook uses search patterns that match the entire content of a cell. Read-only Boolean (bool in C#).
UseWildcards	True if the workbook enables wildcards for character string comparisons and searching. Read-only Boolean (bool in C#).
VBASigned	True if the Visual Basic for Applications project for the specified workbook has been digitally signed. Read-only Boolean.
VBProject	Returns a VBProject object that represents the Visual Basic project in the specified workbook. Read-only.
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.
Windows	Returns a Windows collection that represents all the windows in the specified workbook. Read-only Windows object.
Worksheets	Returns a Sheets collection that represents all the worksheets in the specified workbook. Read-only Sheets object.
WritePassword	Returns or sets a String for the write password of a workbook. Read/write.
WriteReserved	True if the workbook is write-reserved. Read-only Boolean.
WriteReservedBy	Returns the name of the user who currently has write permission for the workbook. Read-only String.
XmlMaps	Returns an XmlMaps collection that represents the schema maps that have been added to the specified workbook. Read-only.
XmlNamespaces	Returns an XmlNamespaces collection that represents the XML namespaces contained in the specified workbook. Read-only.

Methods

_PrintOut(Object, Object, Object, Object, Object, Object, Object)	Reserved for internal use.
_Protect(Object, Object, Object)	Reserved for internal use.
_SaveAs(Object, Object, Object, Object, Object, Object, XlSaveAsAccessMode, Object, Object, Object, Object)	Reserved for internal use.
AcceptAllChanges(Object, Object, Object)	Accepts all changes in the specified shared workbook.
Activate()	Activates the first window associated with the workbook. This won't run any Auto_Activate or Auto_Deactivate macros that might be attached to the workbook (use the RunAutoMacros(XlRunAutoMacro) method to run those macros).
AddToFavorites()	Adds a shortcut to the workbook or a hyperlink to the Favorites folder.
ApplyTheme(String)	Applies the specified theme to the current workbook.
BreakLink(String, XlLinkType)	Converts formulas linked to other Microsoft Excel sources or OLE sources to values.
CanCheckIn()	True if Microsoft Excel can check in a specified workbook to a server.
ChangeFileAccess(XlFileAccess, Object, Object)	Changes the access permissions for the workbook. This may require an updated version to be loaded from the disk.
ChangeLink(String, String, XlLinkType)	Changes a link from one document to another.
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.
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.
Close(Object, Object, Object)	Closes the object.
DeleteNumberFormat(String)	Deletes a custom number format from the workbook.
Dummy16()	Reserved for internal use.
Dummy17(Int32)	Reserved for internal use.
Dummy26()
Dummy27()
EnableConnections()	The EnableConnections() method allows developers to programmatically enable data connections within the workbook for the user.
EndReview()	Terminates a review of a file that has been sent for review using the SendForReview(Object, Object, Object, Object) method.
ExclusiveAccess()	Assigns the current user exclusive access to the workbook that's open as a shared list.
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.
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.
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.
GetWorkflowTasks()	Returns the collection of WorkflowTask objects for the specified workbook.
GetWorkflowTemplates()	Returns the collection of WorkflowTemplate objects for the specified workbook.
HighlightChangesOptions(Object, Object, Object)	Controls how changes are shown in a shared workbook.
LinkInfo(String, XlLinkInfo, Object, Object)	Returns the link date and update status. Object.
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.
LockServerFile()	Locks the workbook on the server to prevent modification.
MergeWorkbook(Object)	Merges changes from one workbook into an open workbook.
NewWindow()	Creates a new window or a copy of the specified window.
OpenLinks(String, Object, Object)	Opens the supporting documents for a link or links.
PivotCaches()	Returns a PivotCaches collection that represents all the PivotTable caches in the specified workbook. Read-only.
PivotTableWizard(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)	Reserved for internal use.
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.
PrintOut(Object, Object, Object, Object, Object, Object, Object, Object)	Prints the object.
PrintOutEx(Object, Object, Object, Object, Object, Object, Object, Object, Object)	Reserved for internal use.
PrintPreview(Object)	Shows a preview of the object as it would look when printed.
Protect(Object, Object, Object)	Protects a workbook so that it cannot be modified.
ProtectSharing(Object, Object, Object, Object, Object, Object)	Saves the workbook and protects it for sharing.
ProtectSharingEx(Object, Object, Object, Object, Object, Object, Object)	Reserved for internal use.
PurgeChangeHistoryNow(Int32, Object)	Removes entries from the change log for the specified workbook.
RecheckSmartTags()	Causes a foreground smart tag check to occur, automatically annotating data that was not annotated before.
RefreshAll()	Refreshes all external data ranges and PivotTable reports in the specified workbook.
RejectAllChanges(Object, Object, Object)	Rejects all changes in the specified shared workbook.
ReloadAs(MsoEncoding)	Reloads a workbook based on an HTML document, using the specified document encoding.
RemoveDocumentInformation(XlRemoveDocInfoType)	Removes all information of the specified type from the workbook.
RemoveUser(Int32)	Disconnects the specified user from the shared 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.
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.
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.
ResetColors()	Resets the color palette to the default colors.
Route()	Routes the workbook, using the workbook's current routing slip.
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.
Save()	Saves changes to the specified workbook.
SaveAs(Object, Object, Object, Object, Object, Object, XlSaveAsAccessMode, Object, Object, Object, Object, Object)	Saves changes to the workbook in a different file.
SaveAsXMLData(String, XmlMap)	Exports the data that has been mapped to the specified XML schema map to an XML data file.
SaveCopyAs(Object)	Saves a copy of the workbook to a file but doesn't modify the open workbook in memory.
sblt(String)	Reserved for internal use.
SendFaxOverInternet(Object, Object, Object)	Sends a worksheet as a fax to the specified recipients.
SendForReview(Object, Object, Object, Object)	Sends a workbook in an e-mail message for review to the specified recipients.
SendMail(Object, Object, Object)	Sends the workbook by using the installed mail system.
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.
SetLinkOnData(String, Object)	Sets the name of a procedure that runs whenever a DDE link is updated.
SetPasswordEncryptionOptions(Object, Object, Object, Object)	Sets the options for encrypting workbooks using passwords.
ToggleFormsDesign()	Toggles form design mode on or off.
Unprotect(Object)	Removes protection from a sheet or workbook. This method has no effect if the sheet or workbook isn't protected.
UnprotectSharing(Object)	Turns off protection for sharing and saves the 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.
UpdateLink(Object, Object)	Updates a Microsoft Excel, DDE, or OLE link (or links).
WebPagePreview()	Displays a preview of the specified workbook as it would look if saved as a Web page.
XmlImport(String, XmlMap, Object, Object)	Imports an XML data file into the current workbook. Returns XlXmlImportResult.
XmlImportXml(String, XmlMap, Object, Object)	Imports an XML data stream that has been previously loaded into memory. Returns XlXmlImportResult.

Applies to