FootnoteOptions Interface

Contains footnote options.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

public interface FootnoteOptions

VB.NET

Public Interface FootnoteOptions

Related API Members

The following members return FootnoteOptions objects:

• Section.FootnoteOptions

Remarks

Use the FootnoteOptions properties to specify the footnote format, location and layout.

The NumberingFormat, StartNumber, and RestartType properties allow you to change footnote’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 footnotes format so they appear as follows:

C#

using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
    wordProcessor.LoadDocument("Document.docx");
    Document document = wordProcessor.Document;
    FootnoteOptions footnoteOptions = document.Sections[0].FootnoteOptions;
    footnoteOptions.NumberingFormat = NumberingFormat.UpperRoman;
    footnoteOptions.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).FootnoteOptions
  footnoteOptions.NumberingFormat = NumberingFormat.UpperRoman
  footnoteOptions.StartNumber = 5
End Using

The Position property allows you to specify one of following footnote locations:

• FootnotePosition.BottomOfPage (default):

  

• FootnotePosition.BelowText:

  

Use FootnoteOptions.ColumnCount property to divide footnotes into columns. This property is ignored when a document is displayed in the RichEditControl. However, you can set this property in code and save its value to a file for further processing in Microsoft Word or other word processing applications.