Document.Footnotes Property

Provides access to the document’s footnotes.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

NoteCollection Footnotes { get; }

VB.NET

ReadOnly Property Footnotes As NoteCollection

Property Value

Type	Description
NoteCollection	A collection of footnotes.

Remarks

The NoteCollection contains document footnotes - notes that appear at the bottom of the page. Call the NoteCollection.Insert method to insert a new note into the specific document position. Pass the symbol used to mark the reference to the Insert method to insert a note with a custom mark.

Access a collection item by its index. The Note object represents a footnote. You can check whether the note has a custom mark (Note.IsCustom), and access a range related to the reference mark (Note.Range). Call the Note.BeginUpdate and Note.EndUpdate paired methods to initiate the update session and access the note’s content.

The code sample below shows how to insert a footnote and append a text:

C#

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.LoadDocument("Document.docx");
    Document document = wordProcessor.Document;

    //Insert a new footnote at the end of the 6th paragraph:
    DocumentPosition footnotePosition = 
    document.CreatePosition(document.Paragraphs[5].Range.End.ToInt() - 1);
    Note footnote = document.Footnotes.Insert(footnotePosition);

    //Access the footnote content
    //And insert text:
    SubDocument footnoteContent = footnote.BeginUpdate();
    footnoteContent.AppendText("First footnote");

    //Finalize the update:
    footnote.EndUpdate(footnoteContent);
}

VB.NET

Using wordProcessor As New RichEditDocumentServer()
  wordProcessor.LoadDocument("Document.docx")
  Dim document As Document = wordProcessor.Document

  'Insert a new footnote at the end of th
  Dim footnotePosition As DocumentPosition = 
  document.CreatePosition(document.Paragraphs(5).Range.End.ToInt() - 1)
  Dim footnote As Note = document.Footnotes.Insert(footnotePosition)

  'Access the footnote content
  'And insert text:
  Dim footnoteContent As SubDocument = footnote.BeginUpdate()
  footnoteContent.AppendText("This is a test footnote")

  'Finalize the update:
  footnote.EndUpdate(footnoteContent)
End Using

Use the NoteCollection.HasSeparator method to determine what separators the footnotes have. The NoteSeparatorType enumeration lists available separator types. Use the NoteCollection.BeginUpdateSeparator and NoteCollection.EndUpdateSeparator paired method to initiate an update session and access separator content.