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 accept/return Comment objects:

• Comment.ParentComment
• CommentCollection.Create(DocumentPosition, Int32, String)
• CommentCollection.Create(DocumentPosition, Int32, String, DateTime)
• CommentCollection.Create(DocumentRange, String)
• CommentCollection.Create(DocumentRange, String, DateTime)
• 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);

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Comment interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/Comments.cs#L24

if (resRanges.Length > 0) {
    Comment newComment = document.Comments.Create("Vicars Anny", document.Comments[1]);
    newComment.Date = DateTime.Now;

comments-simple-example-t474988/CS/CommentsSimpleExample/Form1.cs#L39

//The target comment is the first one
Comment comment = document.Comments[0];
if (comment != null)

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/CommentsActions.cs#L32

if (resRanges.Length > 0) {
    Comment newComment = document.Comments.Create("Vicars Anny", document.Comments[1]);
    newComment.Date = DateTime.Now;

word-processing-document-api-examples-t418535/CS/CodeExamples/CommentsActions.cs#L34

{
    Comment newComment = document.Comments.Create("Vicars Anny", document.Comments[1]);
    newComment.Date = DateTime.Now;

word-document-api-examples/CS/CodeExamples/CommentsActions.cs#L34

{
    Comment newComment = document.Comments.Create("Vicars Anny", document.Comments[1]);
    newComment.Date = DateTime.Now;

VB.NET

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/Comments.vb#L22

If resRanges.Length > 0 Then
    Dim newComment As Comment = document.Comments.Create("Vicars Anny", document.Comments(1))
    newComment.Date = Date.Now

comments-simple-example-t474988/VB/CommentsSimpleExample/Form1.vb#L34

'The target comment is the first one
Dim comment As Comment = document.Comments(0)
If comment IsNot Nothing Then

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/CommentsActions.vb#L30

If resRanges.Length > 0 Then
    Dim newComment As Comment = document.Comments.Create("Vicars Anny", document.Comments(1))
    newComment.Date = Date.Now

word-processing-document-api-examples-t418535/VB/CodeExamples/CommentsActions.vb#L28

If resRanges.Length > 0 Then
    Dim newComment As Comment = document.Comments.Create("Vicars Anny", document.Comments(1))
    newComment.Date = Date.Now

word-document-api-examples/VB/CodeExamples/CommentsActions.vb#L28

If resRanges.Length > 0 Then
    Dim newComment As Comment = document.Comments.Create("Vicars Anny", document.Comments(1))
    newComment.Date = Date.Now