Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

Comment.BeginUpdate() Method

Provides access to a comment’s content to start editing.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

#Declaration

SubDocument BeginUpdate()

#Returns

Type Description
SubDocument

A SubDocument object which is the content of the comment.

#Remarks

The BeginUpdate method allows you to change the content of a current comment. Use the Comment.EndUpdate method to finalize editing.

#Example

View Example

using DevExpress.XtraRichEdit.API.Native;
using DevExpress.XtraRichEdit;
//...

static void EditCommentContent(RichEditDocumentServer wordProcessor) {

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

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

    int commentCount = document.Comments.Count;
    if (commentCount > 0) {

        // Access a comment.
        Comment comment = document.Comments[document.Comments.Count - 1];
        if (comment != null) {

            // Start to edit the comment.
            SubDocument commentDocument = comment.BeginUpdate();

            // Insert text to the comment.
            commentDocument.Paragraphs.Insert(commentDocument.Range.Start);
            commentDocument.InsertText(commentDocument.Range.Start, "some text");

            // Insert a table to the comment.
            commentDocument.Tables.Create(commentDocument.Range.End, 5, 4);

            // Finalize to edit the comment.
            comment.EndUpdate(commentDocument);
        }
    }
}

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginUpdate() 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