CommentCollection.Create(DocumentRange, String, DateTime) Method

Creates a comment for the specified range and assigns the author’s name and creation date.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

Comment Create(
    DocumentRange range,
    string author,
    DateTime date
)

VB.NET

Function Create(
    range As DocumentRange,
    author As String,
    date As Date
) As Comment

Parameters

Name	Type	Description
range	DocumentRange	A DocumentPosition that specifies the start of the range being commented.
author	String	A string that specifies the comment’s author.
date	DateTime	A DateTime object that specifies the comment creation date.

Returns

Type	Description
Comment	A Comment object successfully created.

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)
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 Create(DocumentRange, String, DateTime) 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#L64

    //Create a new comment
    Comment comment = richEditControl.Document.Comments.Create(foundRanges[0], "Johnson Alphonso D", new DateTime(2014, 4, 25));
}

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

string commentAuthor = "Maryland B. Clopton";
document.Comments.Create(docRange, commentAuthor, DateTime.Now);
#endregion #CreateComment

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

string commentAuthor = "Johnson Alphonso D";
document.Comments.Create(docRange, commentAuthor, DateTime.Now);
#endregion #CreateComment

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

string commentAuthor = "Johnson Alphonso D";
document.Comments.Create(docRange, commentAuthor, DateTime.Now);
#endregion #CreateComment

VB.NET

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

    'Create a new comment
    Dim comment As Comment = richEditControl.Document.Comments.Create(foundRanges(0), "Johnson Alphonso D", New Date(2014, 4, 25))
End If

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

            Dim commentAuthor As String = "Maryland B. Clopton"
            document.Comments.Create(docRange, commentAuthor, Date.Now)
'            #End Region ' #CreateComment

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

            Dim commentAuthor As String = "Johnson Alphonso D"
            document.Comments.Create(docRange, commentAuthor, Date.Now)
'            #End Region ' #CreateComment

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

            Dim commentAuthor As String = "Johnson Alphonso D"
            document.Comments.Create(docRange, commentAuthor, Date.Now)
'            #End Region ' #CreateComment