Workbook properties
Office 2013 and later
The Workbook type exposes the following members.
| Name | Description | |
|---|---|---|
|
_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 | 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.) |
|
Sync | Returns a Sync object that provides access to the methods and properties for documents that are part of a Document Workspace. (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.) |
Show: