Partager via


_Workbook Members

Include Protected Members
Include Inherited Members

Represents a Microsoft Excel workbook.

The _Workbook type exposes the following members.

Properties

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

Top

Methods

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

Top

See Also

Reference

_Workbook Interface

Microsoft.Office.Interop.Excel Namespace