We recommend using Visual Studio 2017
This documentation is archived and is not being maintained.

How to: 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.

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

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

To add a new comment to an Excel range

  1. Call the AddComment method of the Microsoft.Office.Interop.Excel.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();
                }
    

Working with Worksheets
How to: Programmatically Display Worksheet Comments
NamedRange Control

Show: