WorkbookBase.Comments Property
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)
Syntax
'Declaration
Public Property Comments As String
Get
Set
public string Comments { get; set; }
Property Value
Type: System.String
The comments attached to the workbook.
Remarks
This property corresponds to the Comments field in the workbook's Properties dialog.
Examples
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.
Private Sub AddWorkbookMetadata()
Me.Comments = "This workbook contains sales data from 2004."
Me.Title = "Sales Data"
Me.Tag = "Sales"
Me.Keywords = "Sales"
Me.Application.Dialogs( _
Excel.XlBuiltInDialog.xlDialogProperties).Show()
End Sub
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(
missing, missing, missing, missing, missing, missing,
missing, missing, missing, missing, missing, missing,
missing, missing, missing, missing, missing, missing,
missing, missing, missing, missing, missing, missing,
missing, missing, missing, missing, missing, missing);
}
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.