Comment Interface

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

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

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 user adds a comment from the User Interface, the comment’s author is obtained from the CommentOptions.Author property.

Example

View Example

CommentsActions.cs

using DevExpress.XtraRichEdit.API.Native;
using DevExpress.XtraRichEdit;

static void CreateComment(RichEditDocumentServer wordProcessor) {

    // Load a document from a file.
    wordProcessor.LoadDocument("Documents\\Grimm.docx");

    // Access a document.
    Document document = wordProcessor.Document;

    if (document.Paragraphs.Count > 2) {
        // Access the range of the third paragraph.
        DocumentRange docRange = document.Paragraphs[2].Range;

        // Specify the comment's author name.
        string commentAuthor = "Johnson Alphonso D";

        // Create a comment.
        document.Comments.Create(docRange, commentAuthor, DateTime.Now);
    }
}

CommentsActions.vb

Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.XtraRichEdit

Shared Sub CreateComment(ByVal wordProcessor As RichEditDocumentServer)
    ' Load a document from a file.
    wordProcessor.LoadDocument("Documents\Grimm.docx")

    ' Access a document.
    Dim document As Document = wordProcessor.Document

    If document.Paragraphs.Count > 2 Then
        ' Access the range of the third paragraph.
        Dim docRange As DocumentRange = document.Paragraphs(2).Range

        ' Specify the comment's author name.
        Dim commentAuthor As String = "Johnson Alphonso D"

        ' Create a comment.
        document.Comments.Create(docRange, commentAuthor, Date.Now)
    End If
End Sub