FootnoteOptions.NumberingFormat Property

Gets or sets the numbering style for the footnote references.

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#

NumberingFormat NumberingFormat { get; set; }

VB.NET

Property NumberingFormat As NumberingFormat

Property Value

Type	Description
NumberingFormat	One of the enumeration members indicating the numbering style.

Available values:

Show 61 items

Name	Description
Decimal	Specifies that the sequence shall consist of decimal numbering. Example: 1, 2, 3, … , 9, 10, 11
AIUEOHiragana	Specifies that the sequence shall consist of hiragana characters in the traditional a-i-u-e-o order. Currently not supported.
AIUEOFullWidthHiragana	Specifies that the sequence shall consist of full-width hiragana characters in the traditional a-i-u-e-o order. Currently not supported.
ArabicAbjad	Specifies that the sequence shall consist of ascending Abjad numerals.
ArabicAlpha	Specifies that the sequence shall consist of characters in the Arabic alphabet.
Bullet	Specifies that the sequence shall consist of bullet characters.
CardinalText	Specifies that the sequence shall consist of cardinal text of the current language. Example: one, two, three. The following languages are currently supported: English, French, German, Italian, Russian, Swedish and Turkish .
Chicago	Specifies that the sequence shall consist of characters as defined in the Chicago Manual of Style. Currently not supported.
ChineseCounting	Specifies that the sequence shall consist of ascending numbers from the Chinese counting system. Currently not supported.
ChineseCountingThousand	Specifies that the sequence shall consist of sequential numbers from the Chinese counting thousand system. Currently not supported.
ChineseLegalSimplified	Specifies that the sequence shall consist of sequential numbers from the Chinese simplified legal format. Currently not supported.
Chosung	Specifies that the sequence shall consist of sequential numbers from the Korean Chosung format. Currently not supported.
DecimalEnclosedCircle	Specifies that the sequence shall consist of decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character. Once the specified sequence reaches 21, the numbers may be replaced with non-enclosed equivalents. Currently not supported.
DecimalEnclosedCircleChinese	Specifies that the sequence shall consist of decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character. Currently not supported.
DecimalEnclosedFullstop	Specifies that the sequence shall consist of decimal numbering followed by a period, using the enclosed alphanumeric glyph character. Currently not supported.
DecimalEnclosedParenthses	For internal use.
DecimalEnclosedParenthesis	Specifies that the sequence shall consist of decimal numbering enclosed in parentheses.
DecimalFullWidth	Specifies that the sequence shall consist of double-byte Arabic numbering. Currently not supported.
DecimalFullWidth2	Specifies that the sequence shall consist of an alternative set of double-byte Arabic numbering, if one exists in the current font. Currently not supported.
DecimalHalfWidth	Specifies that the sequence shall consist of single-byte Arabic numbering. Example: 1, 2, 3
DecimalZero	Specifies that the sequence shall consist of Arabic numbering with a zero added to numbers one through nine. Example: 01, 02, 03, …, 09, 10
Ganada	Specifies that the sequence shall consist of sequential numbers from the Korean Ganada format. Currently not supported.
Hebrew1	Specifies that the sequence shall consist of Hebrew numerals.
Hebrew2	Specifies that the sequence shall consist of the Hebrew alphabet.
Hex	Specifies that the sequence shall consist of hexadecimal numbering. Example: 1, 2, 3, … , 9, A, B
HindiConsonants	Specifies that the sequence shall consist of Hindi consonants. Currently not supported.
HindiDescriptive	Specifies that the sequence shall consist of sequential numbers from the Hindi counting system. Currently not supported.
HindiNumbers	Specifies that the sequence shall consist of Hindi numbers. Currently not supported.
HindiVowels	Specifies that the sequence shall consist of Hindi vowels. Currently not supported.
IdeographDigital	Specifies that the sequence shall consist of sequential numerical ideographs enclosed in a circle, using the appropriate character. Currently not supported.
IdeographEnclosedCircle	Specifies that the sequence shall consist of sequential numerical ideographs enclosed in a circle, using the appropriate character. Currently not supported.
IdeographLegalTraditional	Specifies that the sequence shall consist of traditional sequential numerical legal ideographs. Currently not supported.
IdeographTraditional	Specifies that the sequence shall consist of traditional sequential numerical ideographs. Currently not supported.
IdeographZodiac	Specifies that the sequence shall consist of sequential zodiac ideographs. Currently not supported.
IdeographZodiacTraditional	Specifies that the sequence shall consist of traditional sequential zodiac ideographs. Currently not supported.
Iroha	Specifies that the sequence shall consist of the iroha. Currently not supported.
IrohaFullWidth	Specifies that the sequence shall consist of the full-width forms of the iroha. Currently not supported.
JapaneseCounting	Specifies that the sequence shall consist of sequential numbers from the Japanese counting system. Currently not supported.
JapaneseDigitalTenThousand	Specifies that the sequence shall consist of sequential numbers from the Japanese digital ten thousand counting system. Currently not supported.
JapaneseLegal	Specifies that the sequence shall consist of sequential numbers from the Japanese legal counting system. Currently not supported.
KoreanCounting	Specifies that the sequence shall consist of sequential numbers from the Korean counting system. Currently not supported.
KoreanDigital	Specifies that the sequence shall consist of sequential numbers from the Korean digital counting system. Currently not supported.
KoreanDigital2	Specifies that the sequence shall consist of sequential numbers from the Korean digital counting system. Currently not supported.
KoreanLegal	Specifies that the sequence shall consist of sequential numbers from the Korean legal numbering system. Currently not supported.
LowerLetter	Specifies that the sequence shall consist of the letters of the Latin alphabet in lower case. Example: a, b, c
LowerRoman	Specifies that the sequence shall consist of lowercase roman numerals. Example: i, ii, iii
None	Specifies the default numbering sequence (specifies that the sequence consists of decimal numbering).
NumberInDash	Specifies that the sequence shall consist of Arabic numbering surrounded by dash characters. Example: - 1 -, - 2 -, - 3 -
Ordinal	Specifies that the sequence shall consist of ordinals of the current language. Example: 1st, 2nd, 3rd. The following languages are currently supported: English, French, German, Italian, Russian, Swedish and Turkish .
OrdinalText	Specifies that the sequence shall consist of ordinal text of the current language. Example: first, second, third. The following languages are currently supported: English, French, German, Italian, Russian, Swedish and Turkish .
RussianLower	Specifies that the sequence shall consist of the letters of the Russian alphabet in lower case. Example: а, б, в
RussianUpper	Specifies that the sequence shall consist of the letters of the Russian alphabet in upper case. Example: А, Б, В
TaiwaneseCounting	Specifies that the sequence shall consist of sequential numbers from the Taiwanese counting system. Currently not supported.
TaiwaneseCountingThousand	Specifies that the sequence shall consist of sequential numbers from the Taiwanese counting thousand system. Currently not supported.
TaiwaneseDigital	Specifies that the sequence shall consist of sequential numbers from the Taiwanese digital counting system. Currently not supported.
ThaiDescriptive	Specifies that the sequence shall consist of sequential numbers from the Thai counting system. Currently not supported.
ThaiLetters	Specifies that the sequence shall consist of Thai letters. Currently not supported.
ThaiNumbers	Specifies that the sequence shall consist of Thai numerals. Currently not supported.
UpperLetter	Specifies that the sequence shall consist of the letters of the Latin alphabet in upper case. Example: A, B, C
UpperRoman	Specifies that the sequence shall consist of uppercase roman numerals. Example: I, II, III
VietnameseDescriptive	Specifies that the sequence shall consist of Vietnamese numerals. Currently not supported.

Property Paths

You can access this nested property as listed below:

Object Type	Path to NumberingFormat
Section	.FootnoteOptions .NumberingFormat

Remarks

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