com.spire.pdf
Class PdfPageLabels

java.lang.Object
  com.spire.pdf.PdfPageLabels

public class PdfPageLabels
extends java.lang.Object

The document’s labeling ranges.

Field Summary

static java.lang.String	Decimal_Arabic_Numerals_Style Decimal arabic numerals style to be used for the numeric portion of each page label.
static java.lang.String	Lowercase_Letters_Style Lowercase letters style to be used for the numeric portion of each page label.
static java.lang.String	Lowercase_Roman_Numerals_Style Lowercase roman numerals style to be used for the numeric portion of each page label.
static java.lang.String	Uppercase_Letters_Style Uppercase letters style to be used for the numeric portion of each page label.
static java.lang.String	Uppercase_Roman_Numerals_Style Uppercase roman numerals style to be used for the numeric portion of each page label.

Constructor Summary

PdfPageLabels()
Construct a new instance.

Method Summary

void	addRange(int firstPageIndex, java.lang.String numberStyle, java.lang.String prefix) Add labeling range which is a series of consecutive pages using the same numbering system.
void	addRange(int firstPageIndex, java.lang.String numberStyle, java.lang.String prefix, int numberOfFirstPage) Add labeling range which is a series of consecutive pages using the same numbering system.
java.lang.String	getPageLabel(int index) Get page label.

Field Detail

Decimal_Arabic_Numerals_Style

public static final java.lang.String Decimal_Arabic_Numerals_Style

Decimal arabic numerals style to be used for the numeric portion of each page label.

See Also:

Constant Field Values

Uppercase_Roman_Numerals_Style

public static final java.lang.String Uppercase_Roman_Numerals_Style

Uppercase roman numerals style to be used for the numeric portion of each page label.

See Also:

Constant Field Values

Lowercase_Roman_Numerals_Style

public static final java.lang.String Lowercase_Roman_Numerals_Style

Lowercase roman numerals style to be used for the numeric portion of each page label.

See Also:

Constant Field Values

Uppercase_Letters_Style

public static final java.lang.String Uppercase_Letters_Style

Uppercase letters style to be used for the numeric portion of each page label.

See Also:

Constant Field Values

Lowercase_Letters_Style

public static final java.lang.String Lowercase_Letters_Style

Lowercase letters style to be used for the numeric portion of each page label.

See Also:

Constant Field Values

Constructor Detail

PdfPageLabels

public PdfPageLabels()

Construct a new instance.

Method Detail

addRange

public void addRange(int firstPageIndex,
                     java.lang.String numberStyle,
                     java.lang.String prefix)

Add labeling range which is a series of consecutive pages using the same numbering system.

Parameters:

firstPageIndex - The index of the first page in the labeling range.

numberStyle - The numbering style to be used for the numeric portion of each page label. As follow:Decimal_Arabic_Numerals/Uppercase_Roman_Numerals/Lowercase_Roman_Numerals/Uppercase_Letters/Lowercase_Letters

prefix - The label prefix for page labels in the labeling range.

addRange

public void addRange(int firstPageIndex,
                     java.lang.String numberStyle,
                     java.lang.String prefix,
                     int numberOfFirstPage)

Add labeling range which is a series of consecutive pages using the same numbering system.

Parameters:

firstPageIndex - The index of the first page in the labeling range.

numberStyle - The numbering style to be used for the numeric portion of each page label. As follow:Decimal_Arabic_Numerals/Uppercase_Roman_Numerals/Lowercase_Roman_Numerals/Uppercase_Letters/Lowercase_Letters

prefix - The label prefix for page labels in the labeling range.

numberOfFirstPage - The value of the numeric portion for the first page label in the range. Subsequent pages are numbered sequentially from this value, which must be greater than or equal to 1. Default value: 1.

getPageLabel

public java.lang.String getPageLabel(int index)

Get page label.

Parameters:

index - The page index.

Returns:

The page label.