Home Library Learn Samples Downloads Support Community Forums
MSDN Library
Development Tools and Languages
Visual Studio 2012
Office Development in Visual Studio
Create Add-ins and Customizations for Office by using Visual Studio
Managed Reference (Office Development in Visual Studio)
Microsoft.Office.Tools.Excel
WorkbookBase Class
WorkbookBase Properties
_CodeName Property
_ReadOnlyRecommended Property
AcceptLabelsInFormulas Property
AccuracyVersion Property
ActiveChart Property
ActiveSheet Property
ActiveSlicer Property
Application Property
Author Property
AutoUpdateFrequency Property
AutoUpdateSaveChanges Property
Base Property
BindingContext Property
BuiltinDocumentProperties Property
CalculationVersion Property
ChangeHistoryDuration Property
Charts Property
CheckCompatibility Property
CodeName Property
Colors Property
CommandBars Property
Comments Property
ConflictResolution Property
Connections Property
ConnectionsDisabled Property
Container Property
ContentTypeProperties Property
CreateBackup Property
Creator Property
CustomDocumentProperties Property
CustomViews Property
CustomXMLParts Property
DataBindings Property
DataHost Property
Date1904 Property
DefaultPivotTableStyle Property
DefaultSlicerStyle Property
DefaultTableStyle Property
DialogSheets Property
DisplayDrawingObjects Property
DisplayInkComments Property
DocumentInspectors Property
DocumentLibraryVersions Property
DoNotPromptForConvert Property
EnableAutoRecover Property
EncryptionProvider Property
EnvelopeVisible Property
Excel4IntlMacroSheets Property
Excel4MacroSheets Property
Excel8CompatibilityMode Property
IExtension.ExtensionBase Property
FileFormat Property
Final Property
ForceFullCalculation Property
FullName Property
FullNameURLEncoded Property
HasMailer Property
HasPassword Property
HasRoutingSlip Property
HasVBProject Property
HighlightChangesOnScreen Property
HostContext Property
HTMLProject Property
IconSets Property
InactiveListBorderVisible Property
InnerObject Property
IsAddin Property
IsInplace Property
ItemProvider Property
KeepChangeHistory Property
Keywords Property
ListChangesOnNewSheet Property
Mailer Property
Modules Property
MultiUserEditing Property
Name Property
Names Property
OnSave Property
OnSheetActivate Property
OnSheetDeactivate Property
Parent Property
Password Property
PasswordEncryptionAlgorithm Property
PasswordEncryptionFileProperties Property
PasswordEncryptionKeyLength Property
PasswordEncryptionProvider Property
Path Property
Permission Property
PersonalViewListSettings Property
PersonalViewPrintSettings Property
PrecisionAsDisplayed Property
ProtectStructure Property
ProtectWindows Property
PublishObjects Property
ReadOnly Property
ReadOnlyRecommended Property
RemovePersonalInformation Property
Research Property
RevisionNumber Property
Routed Property
RoutingSlip Property
Saved Property
SaveLinkValues Property
ServerPolicy Property
ServerViewableItems Property
SharedWorkspace Property
Sheets Property
ShowConflictHistory Property
ShowPivotChartActiveFields Property
ShowPivotTableFieldList Property
Signatures Property
Site Property
SlicerCaches Property
SmartDocument Property
SmartTagOptions Property
Styles Property
Subject Property
Sync Property
TableStyles Property
Tag Property
TemplateRemoveExtData Property
Theme Property
Title Property
UpdateLinks Property
UpdateRemoteReferences Property
UserControl Property
UserStatus Property
VBASigned Property
VBProject Property
VstoSmartTags Property
WebOptions Property
Windows Property
Worksheets Property
WritePassword Property
WriteReserved Property
WriteReservedBy Property
XmlMaps Property
XmlNamespaces Property
Expand Minimize
This topic has not yet been rated - Rate this topic

WorkbookBase.Comments Property

Visual Studio 2012

Gets or sets the comments attached to the workbook.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel.v4.0.Utilities (in Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
C#
VB
Copy 
public string Comments { get; set; }

Property Value

Type: String
The comments attached to the workbook.

This property corresponds to the Comments field in the workbook's Properties dialog.

The following code example sets values in the Comments, Title and Tag properties and then programmatically displays the Microsoft Office Excel Properties dialog to verify that these values were set.

This example is for a document-level customization.

C#
VB
Copy 
private void AddWorkbookMetadata()
{
    this.Comments = "This workbook contains sales data from 2004.";
    this.Title = "Sales Data";
    this.Tag = "Sales";
    this.Keywords = "Sales";

    this.Application.Dialogs[
        Excel.XlBuiltInDialog.xlDialogProperties].Show();
}
Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.