CommentCollection.Create(String, DateTime, Comment) Method

Creates a nested comment with the specified author’s name and creation date.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

Comment Create(
    string author,
    DateTime date,
    Comment parentComment
)

VB.NET

Function Create(
    author As String,
    date As Date,
    parentComment As Comment
) As Comment

Parameters

Name	Type	Description
author	String	A String value that sets the Comment.Author property.
date	DateTime	A DateTime object that is the comment creation date.
parentComment	Comment	A Comment object that is the parent comment.

Returns

Type	Description
Comment	A Comment object that is the nested comment.

Remarks

The created comment is added to the SubDocument.Comments collection automatically .

Example

View Example

CommentsActions.cs

static void CreateNestedComment(RichEditDocumentServer wordProcessor) {
    // Load a document from a file.
    wordProcessor.LoadDocument("Documents\\Grimm.docx", DocumentFormat.OpenXml);

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

    if (document.Comments.Count > 1)
    {
        // Create a new comment nested in the parent comment.
        Comment newComment = document.Comments.Create("Vicars Anny", document.Comments[1]);
        newComment.Date = DateTime.Now;
        SubDocument commentDocument = newComment.BeginUpdate();
        commentDocument.InsertText(commentDocument.Range.Start, "I agree");
        newComment.EndUpdate(commentDocument);
    }
}

CommentsActions.vb

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

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

    If document.Comments.Count > 1 Then
        ' Create a new comment nested in the parent comment.
        Dim newComment As Comment = document.Comments.Create("Vicars Anny", document.Comments(1))
        newComment.Date = Date.Now
        Dim commentDocument As SubDocument = newComment.BeginUpdate()
        commentDocument.InsertText(commentDocument.Range.Start, "I agree")
        newComment.EndUpdate(commentDocument)
    End If
End Sub