Edit

Programmatically add and delete worksheet comments

  • Article

You can programmatically add and delete comments in Microsoft Office Excel worksheets. Comments can be added only to single cells, not to multi-cell ranges.

Applies to: The information in this topic applies to document-level projects and VSTO Add-in projects for Excel. For more information, see Features available by Office application and project type.

Add and delete a comment in a document-level project

The following examples assume that there is a single-cell NamedRange control named dateComment on a worksheet named Sheet1.

To add a new comment to a named range

  1. Call the AddComment method of the NamedRange control and supply the comment text. This code must be placed in the Sheet1 class.

    this.dateComment.AddComment("Comment added " + DateTime.Now.ToString());

To delete a comment from a named range

  1. Verify that a comment exists on the range and delete it. This code must be placed in the Sheet1 class.

    if (this.dateComment.Comment != null)
{
    this.dateComment.Comment.Delete();
}

Add and delete a comment in a VSTO Add-in project

The following examples assume that there is a single-cell Range named dateComment on the active worksheet.

To add a new comment to an Excel range

  1. Call the AddComment method of the Range and supply the comment text.

    Excel.Range dateComment = this.Application.get_Range("A1");
dateComment.AddComment("Comment added " + DateTime.Now.ToString());

To delete a comment from an Excel range

  1. Verify that a comment exists on the range and delete it.

    Excel.Range dateComment = this.Application.get_Range("A1");
if (dateComment.Comment != null)
{
    dateComment.Comment.Delete();
}

Related content