Skip to main content

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

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

Declaration

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

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

Comment

View Example

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);
    }
}

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.

See Also