EndnoteOptions Interface

Contains endnote options.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public interface EndnoteOptions

VB.NET

Public Interface EndnoteOptions

Related API Members

The following members return EndnoteOptions objects:

• Section.EndnoteOptions

Remarks

Use the EndnoteOptions properties to specify the format of endnotes. The options are applied to endnotes in the current section.

The NumberingFormat, StartNumber, and RestartType properties allow you to change endnote’s format. If the RestartType property is set to NoteRestartType.NewSection or NoteRestartType.NewPage, the StartNumber property value is ignored.

The code sample below shows how to change the endnotes’ format so they appear as follows:

C#

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.LoadDocument("Document.docx");
    Document document = wordProcessor.Document;
    EndnoteOptions endnoteOptions = document.Sections[0].EndnoteOptions;
    endnoteOptions.NumberingFormat = NumberingFormat.UpperRoman;
    endnoteOptions.StartNumber = 5;
}

VB.NET

Using wordProcessor As New RichEditDocumentServer()
  wordProcessor.LoadDocument("Document.docx")
  Dim document As Document = wordProcessor.Document
  Dim footnoteOptions As FootnoteOptions = document.Sections(0).EndnoteOptions
  endnoteOptions.NumberingFormat = NumberingFormat.UpperRoman
  endnoteOptions.StartNumber = 5
End Using

Use the Document.EndnotePosition property to specify the endnote location. You can place endnotes at the end of the document, or they can appear at the end of each section.

The code sample below shows how to use this property:

C#

RichEditDocumentServer wordProcessor = new RichEditDocumentServer();
wordProcessor.LoadDocument("Document.docx");
Document document = wordProcessor.Document;
document.EndnotePosition = EndnotePosition.EndOfSection;

VB.NET

Dim wordProcessor As New RichEditDocumentServer()
wordProcessor.LoadDocument("Documents.docx")
Dim document As Document = wordProcessor.Document
document.EndnotePosition = EndnotePosition.EndOfSection