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.v19.1.Core.dll

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

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)
If document.Comments.Count > 0 Then
    Dim resRanges() As DocumentRange = document.FindAll("trump", SearchOptions.None, document.Comments(1).Range)
    If resRanges.Length > 0 Then
        Dim newComment As Comment = document.Comments.Create("Vicars Anny", document.Comments(1))
        newComment.Date = Date.Now
    End If
End If

Comments.cs

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
if (document.Comments.Count > 0) {
    DocumentRange[] resRanges = document.FindAll("trump", SearchOptions.None, document.Comments[1].Range);
    if (resRanges.Length > 0) {
        Comment newComment = document.Comments.Create("Vicars Anny", document.Comments[1]);
        newComment.Date = DateTime.Now;
    }
}

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Create(String, DateTime, Comment) method.

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#

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

//Create a new comment nested to the second comment in the collection
Comment nestedComment = document.Comments.Create("Brian Zetc", DateTime.Now, document.Comments[1]);

VB.NET

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

'Create a new comment nested to the second comment in the collection
Dim nestedComment As Comment = document.Comments.Create("Brian Zetc", Date.Now, document.Comments(1))