Comment Interface

A comment in the document - a text note that is attached to a DocumentRange.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[ComVisible(true)]
public interface Comment

VB.NET

<ComVisible(True)>
Public Interface Comment

Related API Members

The following members return Comment objects:

• Comment.ParentComment
• CommentCollection.Create(DocumentPosition, Int32, String, DateTime)
• CommentCollection.Create(DocumentPosition, Int32, String)
• CommentCollection.Create(DocumentRange, String, DateTime)
• CommentCollection.Create(DocumentRange, String)
• CommentCollection.Create(String, Comment)
• CommentCollection.Create(String, DateTime, Comment)
• CommentCollection.Item[String]
• CommentEditingEventArgs.Comment
• LayoutComment.GetDocumentComment()

Remarks

Comments are contained in the CommentCollection, which is accessed by the SubDocument.Comments property.

Use the CommentCollection.Create to create a new comment with the specified settings.

Note

When the end-user adds a comment via UI commands, the comment’s author is obtained from the CommentOptions.Author property.

Example

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-richedit-document-api-e5219

Comments.vb

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
Dim docRange As DocumentRange = document.Paragraphs(2).Range
Dim commentAuthor As String = "Johnson Alphonso D"
document.Comments.Create(docRange, commentAuthor, Date.Now)

Comments.cs

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
DocumentRange docRange = document.Paragraphs[2].Range;
string commentAuthor = "Johnson Alphonso D";
document.Comments.Create(docRange, commentAuthor, DateTime.Now);