officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-comment.md
Provides access to a comment’s content to start editing.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
SubDocument BeginUpdate()
Function BeginUpdate As SubDocument
| Type | Description |
|---|---|
| SubDocument |
A SubDocument object which is the content of the comment.
|
The BeginUpdate method allows you to change the content of a current comment. Use the Comment.EndUpdate method to finalize editing.
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.Docx);
// 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);
}
}
}
Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.XtraRichEdit
'...
Shared Sub EditCommentContent(ByVal wordProcessor As RichEditDocumentServer)
' Load a document from a file.
wordProcessor.LoadDocument("Documents\Grimm.docx", DocumentFormat.Docx)
' Access a document.
Dim document As Document = wordProcessor.Document
Dim commentCount As Integer = document.Comments.Count
If commentCount > 0 Then
' Access a comment.
Dim comment As Comment = document.Comments(document.Comments.Count - 1)
If comment IsNot Nothing Then
' Start to edit the comment.
Dim commentDocument As SubDocument = 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)
End If
End If
End Sub
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.
winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Comments.cs#L69
{
SubDocument commentDocument = comment.BeginUpdate();
commentDocument.InsertText(commentDocument.CreatePosition(0), "some text");
word-document-api-examples/CS/CodeExamples/ProtectionActions.cs#L36
// Access the comment content.
SubDocument commentDocument = document.Comments[0].BeginUpdate();
winforms-richedit-iterate-through-all-sub-documents/CS/SubDocumentHelper.cs#L52
{
SubDocument commentSubDocument = comment.BeginUpdate();
subDocumentProcessor(commentSubDocument);
wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/CommentsActions.cs#L92
{
SubDocument commentDocument = comment.BeginUpdate();
commentDocument.InsertText(commentDocument.CreatePosition(0), "comment text");
word-document-api-iterate-through-all-sub-documents/CS/SubDocumentHelper.cs#L52
{
SubDocument commentSubDocument = comment.BeginUpdate();
subDocumentProcessor(commentSubDocument);
winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Comments.vb#L61
If comment IsNot Nothing Then
Dim commentDocument As DevExpress.XtraRichEdit.API.Native.SubDocument = comment.BeginUpdate()
commentDocument.InsertText(commentDocument.CreatePosition(0), "some text")
word-document-api-examples/VB/CodeExamples/ProtectionActions.vb#L33
' Access the comment content.
Dim commentDocument As DevExpress.XtraRichEdit.API.Native.SubDocument = document.Comments(CInt((0))).BeginUpdate()
' Specify the comment text to indicate that the document is protected.
winforms-richedit-iterate-through-all-sub-documents/VB/SubDocumentHelper.vb#L46
For Each comment As Comment In comments
Dim commentSubDocument As SubDocument = comment.BeginUpdate()
subDocumentProcessor(commentSubDocument)
wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/CommentsActions.vb#L81
If comment IsNot Nothing Then
Dim commentDocument As SubDocument = comment.BeginUpdate()
commentDocument.InsertText(commentDocument.CreatePosition(0), "comment text")
word-document-api-iterate-through-all-sub-documents/VB/SubDocumentHelper.vb#L46
For Each comment As Comment In comments
Dim commentSubDocument As SubDocument = comment.BeginUpdate()
subDocumentProcessor(commentSubDocument)
See Also