CommentCollection.Create(DocumentRange, String) Method

Creates a new Comment with the specified settings.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

Comment Create(
    DocumentRange range,
    string author
)

VB.NET

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

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange for which a comment is being created.
author	String	A String value that sets the Comment.Author property.

Returns

Type	Description
Comment	A Comment object.

Remarks

Use the Create method to create a comment and add it to the collection of comments in a document.

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Create(DocumentRange, String) 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#

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/SelectionCollection.cs#L114

Comment comment = document.Comments.Create(document.Selection, "");
SubDocument commentDoc = comment.BeginUpdate();

word-document-api-examples/CS/CodeExamples/ProtectionActions.cs#L33

// Create a comment related to the first paragraph.
document.Comments.Create(document.Paragraphs[0].Range, "Admin");

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

    string commentAuthor = "Maryland B. Clopton";
    document.Comments.Create(docRange, commentAuthor);
}

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/SelectionCollection.vb#L104

document.Selections.Add(ranges)
Dim comment As DevExpress.XtraRichEdit.API.Native.Comment = document.Comments.Create(document.Selection, "")
Dim commentDoc As DevExpress.XtraRichEdit.API.Native.SubDocument = comment.BeginUpdate()

word-document-api-examples/VB/CodeExamples/ProtectionActions.vb#L31

' Create a comment related to the first paragraph.
document.Comments.Create(document.Paragraphs(CInt((0))).Range, "Admin")
' Access the comment content.

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

    Dim commentAuthor As String = "Maryland B. Clopton"
    document.Comments.Create(docRange, commentAuthor)
End Sub