PageNumberTypeClass

Definition

Namespace: DOM.Elements
Assembly: DOM.dll

Describes how page numbers are formatted and displayed for a page or section.

Remarks

centralizes numbering options such as chapter separators, chapter numbering style, numeric format and the starting page index. Consumers (layout, header/footer generators and exporters) should consult these values when rendering page number fields. PageNumberType This class is intended as the base for concrete page number implementations (see, which adds alignment and odd/even behaviour). PageNumber

Examples

csharp

1// 1. Decimal numbering starting at 1

2var pnt = new PageNumberType

4 NumberFormat = NumberFormatValues.Decimal,

5 StartingPageNumber = 1

6};

csharp

1// 2. Roman lowercase for front matter

2var pnt = new PageNumberType

4 NumberFormat = NumberFormatValues.lowerRoman,

5 StartingPageNumber = 1

6};

csharp

1// 3. Include chapter numbers from Heading 1

2var pnt = new PageNumberType

4 IncludeChapterNumber = true,

5 ChapterHeadingLevel = 1,

6 ChapterSeparator = ChapterSeparatorValues.period,

7 NumberFormat = NumberFormatValues.Decimal

8};

csharp

1// 4. Start numbering at 0 for cover-inclusive documents

2var pnt = new PageNumberType

4 NumberFormat = NumberFormatValues.Decimal,

5 StartingPageNumber = 0

6};

Properties

ChapterHeadingLevel

Gets or sets the heading level used to determine the current chapter number.

ChapterSeparatorChapterSeparatorValues

Gets or sets the separator used between chapter and page numbers.

IncludeChapterNumber

Gets or sets a value indicating whether the page number should be prefixed with the chapter number.

NumberFormatNumberFormatValues

Gets or sets the numeric format used to render the page number.

StartingPageNumber

Gets or sets the starting page number for the sequence.