How to: Programmatically Add Comments to Text in Documents

The Comments property of the Document class adds a comment to a range of text in a Microsoft Office Word document.

Applies to: The information in this topic applies to document-level projects and application-level projects for Word 2013 and Word 2010. For more information, see Features Available by Office Application and Project Type.

The following example adds a comment to the first paragraph in the document.

To add a new comment to text in a document-level customization

• Call the Add method of the Comments property and supply a range and the comment text. To use the following code example, run it from the ThisDocument class in your project.

  Me.Comments.Add(Me.Paragraphs(1).Range, "Add a comment to the first paragraph.")
  

  object text = "Add a comment to the first paragraph.";
  this.Comments.Add(this.Paragraphs[1].Range, ref text);
  

To add a new comment to text in an application-level add-in

• Call the Add method of the Comments property and supply a range and the comment text.

  The following code example adds a comment to the active document. To use this example, run it from the ThisAddIn class in your project.

  Me.Application.ActiveDocument.Comments.Add( _
      Me.Application.ActiveDocument.Paragraphs(1).Range, _
      "Add a comment to the first paragraph.")
  

  object text = "Add a comment to the first paragraph.";
  this.Application.ActiveDocument.Comments.Add(
      this.Application.ActiveDocument.Paragraphs[1].Range, ref text);
  

Robust Programming

To change the user initials that Word adds to comments, use the UserInitials property.

See Also

Tasks

How to: Programmatically Remove All Comments from Documents

Concepts

Document Host Item