Comment.BeginUpdate() Method

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

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

SubDocument BeginUpdate()

VB.NET

Function BeginUpdate As SubDocument

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

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 commentCount As Integer = document.Comments.Count
If commentCount > 0 Then
    Dim comment As DevExpress.XtraRichEdit.API.Native.Comment = document.Comments(document.Comments.Count - 1)
    If comment IsNot Nothing Then
        Dim commentDocument As SubDocument = comment.BeginUpdate()
        commentDocument.InsertText(commentDocument.CreatePosition(0), "some text")
        commentDocument.Tables.Create(commentDocument.CreatePosition(9), 5, 4)
        comment.EndUpdate(commentDocument)
    End If
End If

Comments.cs

document.LoadDocument("Grimm.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
int commentCount = document.Comments.Count;
if (commentCount > 0)
{
    DevExpress.XtraRichEdit.API.Native.Comment comment = document.Comments[document.Comments.Count - 1];
    if (comment != null)
    {
        SubDocument commentDocument = comment.BeginUpdate();
        commentDocument.InsertText(commentDocument.CreatePosition(0), "some text");
        commentDocument.Tables.Create(commentDocument.CreatePosition(9), 5, 4);
        comment.EndUpdate(commentDocument);
    }
}

Related GitHub Examples

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.

C#

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

{
    SubDocument commentDocument = comment.BeginUpdate();
    commentDocument.InsertText(commentDocument.CreatePosition(0), "some text");

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

//Open the comment for modification
SubDocument commentDocument = comment.BeginUpdate();

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

document.Comments.Create(document.Paragraphs[0].Range, "Admin");
SubDocument commentDocument = document.Comments[0].BeginUpdate();
commentDocument.InsertText(commentDocument.CreatePosition(0),

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

{
    SubDocument commentDocument = comment.BeginUpdate();
    commentDocument.InsertText(commentDocument.CreatePosition(0), "comment text");

How-to-iterate-through-all-SubDocuments/CS/SubDocumentIterator/SubDocumentHelper.cs#L52

{
    SubDocument commentSubDocument = comment.BeginUpdate();
    subDocumentProcessor(commentSubDocument);

VB.NET

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

If comment IsNot Nothing Then
    Dim commentDocument As SubDocument = comment.BeginUpdate()
    commentDocument.InsertText(commentDocument.CreatePosition(0), "some text")

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

'Open the comment for modification
Dim commentDocument As SubDocument = comment.BeginUpdate()

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

document.Comments.Create(document.Paragraphs(0).Range, "Admin")
Dim commentDocument As SubDocument = document.Comments(0).BeginUpdate()
commentDocument.InsertText(commentDocument.CreatePosition(0), "Document is protected with a password." & vbLf & "You cannot modify the document until protection is removed.")

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

If comment IsNot Nothing Then
    Dim commentDocument As SubDocument = comment.BeginUpdate()
    commentDocument.InsertText(commentDocument.CreatePosition(0), "comment text")

How-to-iterate-through-all-SubDocuments/VB/SubDocumentIterator/SubDocumentHelper.vb#L45

For Each comment As Comment In comments
    Dim commentSubDocument As SubDocument = comment.BeginUpdate()
    subDocumentProcessor(commentSubDocument)