This documentation is archived and is not being maintained.

Workbook.Comments Property

Gets or sets the comments attached to the workbook.

Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel (in microsoft.office.tools.excel.dll)

public virtual string Comments { get; set; }

Property Value

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.

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);
}

Show: