Programmatically add and delete worksheet comments

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.

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

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

   • C#
   • VB

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

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

   • C#
   • VB

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

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

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

   • C#
   • VB

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

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

   • C#
   • VB

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

• Work with worksheets
• How to: Programmatically display worksheet comments
• NamedRange control