Note.EndUpdate(SubDocument) Method

Finalizes the note update.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

void EndUpdate(
    SubDocument document
)

VB.NET

Sub EndUpdate(
    document As SubDocument
)

Parameters

Name	Type	Description
document	SubDocument	The note opened for editing.

Remarks

Use the Note.BeginUpdate() - Note.EndUpdate() methods to initiate the update session and access note content.

The code sample belows shows how to change the footnote’s text:

C#

static void EditFootnote(RichEditDocumentServer wordProcessor)
{
    wordProcessor.LoadDocument("Documents//Grimm.docx");
    Document document = wordProcessor.Document;

    //Access the footnote's content:
    SubDocument footnote = document.Footnotes[0].BeginUpdate();

    //Exclude the reference mark and the space after it from the range to be edited:
    DocumentRange noteTextRange = 
    footnote.CreateRange(footnote.Range.Start.ToInt() + 2, footnote.Range.Length
        - 2);
    //Clear the range and insert a new text:
    footnote.Delete(noteTextRange);
    footnote.AppendText("the text is removed");

    //Finalize the footnote update:
    document.Footnotes[0].EndUpdate(footnote);
}

VB.NET

Shared Sub EditFootnote(ByVal wordProcessor As RichEditDocumentServer)
  wordProcessor.LoadDocument("Documents//Grimm.docx")
  Dim document As Document = wordProcessor.Document

  'Access the footnote's content:
  Dim footnote As SubDocument = document.Footnotes(0).BeginUpdate()

  'Exclude the reference mark and the space after it from the range to be edited:
  Dim noteTextRange As DocumentRange = 
  footnote.CreateRange(footnote.Range.Start.ToInt() + 2, footnote.Range.Length - 2)
  'Clear the range and insert a new text:
  footnote.Delete(noteTextRange)
  footnote.AppendText("the text is removed")

  'Finalize the footnote update:
  document.Footnotes(0).EndUpdate(footnote)
End Sub

Related GitHub Examples

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

word-document-api-examples/CS/CodeExamples/NotesActions.cs#L62

//Finalize the update:
document.Footnotes[0].EndUpdate(footnote);
#endregion #EditFootnote

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/NotesActions.cs#L59

//Finalize the update:
document.Footnotes[0].EndUpdate(footnote);
#endregion #EditFootnote

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Notes.cs#L59

//Finalize the update:
document.Footnotes[0].EndUpdate(footnote);
#endregion #EditFootnote

VB.NET

word-document-api-examples/VB/CodeExamples/NotesActions.vb#L47

            'Finalize the update:
            document.Footnotes(CInt((0))).EndUpdate(footnote)
#End Region  ' #EditFootnote

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/NotesActions.vb#L53

            'Finalize the update:
            document.Footnotes(0).EndUpdate(footnote)
'            #End Region ' #EditFootnote

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Notes.vb#L44

            'Finalize the update:
            document.Footnotes(CInt((0))).EndUpdate(footnote)
#End Region  ' #EditFootnote