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

Note.BeginUpdate() Method

Opens a note for 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

The note opened for editing.

#Remarks

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

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

static void EditNote(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);

    //Access the first endnote's content:
    SubDocument endnote = document.Endnotes[0].BeginUpdate();

    //Exclude the reference mark and the space after it from the range to be edited:
    DocumentRange noteTextRange = endnote.CreateRange(endnote.Range.Start.ToInt() + 2, endnote.Range.Length
        - 2);

    //Access the range's character properties:
    CharacterProperties characterProperties = endnote.BeginUpdateCharacters(noteTextRange);

    characterProperties.ForeColor = System.Drawing.Color.Red;
    characterProperties.Italic = true;

    //Finalize the character options update:
    endnote.EndUpdateCharacters(characterProperties);

    //Finalize the endnote update:
    document.Endnotes[0].EndUpdate(endnote);
}

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