PageLabel

Overview

PageLabel is a class in Aspose.PDF FOSS for .NET.

Represents a page label range.

This class provides 4 methods for working with PageLabel objects in .NET programs. Available methods include: FormatLabel, FormatNumber, ToAlpha, ToRoman. All public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package. Properties: LastPageIndex, NumberingStyle, NumberingStyleName, Prefix, Start, StartPage, and 2 more.

Properties

NameTypeAccessDescription
StartPageintRead/Write0-based page index where this label range starts.
LastPageIndexintRead0-based page index of the last page this range applies to, or -1 for end of document.
StyleNumberingStyleRead/WriteThe numbering style.
NumberingStyleNumberingStyleRead/WriteAlias for Style.
StartingValueintRead/WriteAlias for Start.
NumberingStyleNamestringReadThe numbering style as a string (e.g., “NumeralsArabic”, “NumeralsRomanUppercase”).
Prefixstring?Read/WriteThe label prefix string (empty string if not set).
StartintRead/WriteThe starting number for this range.

Methods

SignatureDescription
FormatLabel(pageIndex: int)Format a label for a page at the given 0-based index.
FormatNumber(num: int, style: NumberingStyle)Format a positive integer according to the given numbering style.
ToRoman(num: int)Convert a positive integer to an uppercase Roman numeral string.
ToAlpha(num: int)Convert a positive integer to an alphabetic label (A=1, Z=26, AA=27, etc.).

See Also