iTextSharp.text.pdf.PdfPageLabels Class Reference

Classes
class	PdfPageLabelFormat

Public Member Functions
	PdfPageLabels ()
void	AddPageLabel (int page, int numberStyle, string text, int firstPage)
void	AddPageLabel (int page, int numberStyle, string text)
void	AddPageLabel (int page, int numberStyle)
void	AddPageLabel (PdfPageLabelFormat format)
void	RemovePageLabel (int page)

Static Public Member Functions
static String[]	GetPageLabels (PdfReader reader)
static PdfPageLabelFormat[]	GetPageLabelFormats (PdfReader reader)

Static Public Attributes
const int	DECIMAL_ARABIC_NUMERALS = 0
const int	UPPERCASE_ROMAN_NUMERALS = 1
const int	LOWERCASE_ROMAN_NUMERALS = 2
const int	UPPERCASE_LETTERS = 3
const int	LOWERCASE_LETTERS = 4
const int	EMPTY = 5

Detailed Description

Page labels are used to identify each page visually on the screen or in print.

Author

Paulo Soares (psoar.nosp@m.es@c.nosp@m.onsis.nosp@m.te.p.nosp@m.t)

Constructor & Destructor Documentation

PdfPageLabels()

iTextSharp.text.pdf.PdfPageLabels.PdfPageLabels

(

)

Creates a new PdfPageLabel with a default logical page 1

Member Function Documentation

AddPageLabel() [1/4]

void iTextSharp.text.pdf.PdfPageLabels.AddPageLabel	(	int	page,
		int	numberStyle
	)

Adds or replaces a page label. There is no text prefix and the first logical page has the default of 1.

Parameters

page	the real page to start the numbering. First page is 1
numberStyle	the numbering style such as LOWERCASE_ROMAN_NUMERALS

AddPageLabel() [2/4]

void iTextSharp.text.pdf.PdfPageLabels.AddPageLabel	(	int	page,
		int	numberStyle,
		string	text
	)

Adds or replaces a page label. The first logical page has the default of 1.

Parameters

page	the real page to start the numbering. First page is 1
numberStyle	the numbering style such as LOWERCASE_ROMAN_NUMERALS
text	the text to prefix the number. Can be null or empty

AddPageLabel() [3/4]

void iTextSharp.text.pdf.PdfPageLabels.AddPageLabel	(	int	page,
		int	numberStyle,
		string	text,
		int	firstPage
	)

Adds or replaces a page label.

Parameters

page	the real page to start the numbering. First page is 1
numberStyle	the numbering style such as LOWERCASE_ROMAN_NUMERALS
text	the text to prefix the number. Can be null or empty
firstPage	the first logical page number

AddPageLabel() [4/4]

void iTextSharp.text.pdf.PdfPageLabels.AddPageLabel

(

PdfPageLabelFormat

format

)

Adds or replaces a page label.

GetPageLabelFormats()

static PdfPageLabelFormat [] iTextSharp.text.pdf.PdfPageLabels.GetPageLabelFormats ( PdfReader  reader )

static

Retrieves the page labels from a PDF as an array of PdfPageLabelFormat objects.

Parameters

reader

a PdfReader object that has the page labels you want to retrieve

Returns

a PdfPageLabelEntry array, containing an entry for each format change or null if no page labels are present

GetPageLabels()

static String [] iTextSharp.text.pdf.PdfPageLabels.GetPageLabels ( PdfReader  reader )

static

Retrieves the page labels from a PDF as an array of String objects.

Parameters

reader

a PdfReader object that has the page labels you want to retrieve

Returns

a String array or null if no page labels are present

RemovePageLabel()

void iTextSharp.text.pdf.PdfPageLabels.RemovePageLabel

(

int

page

)

Removes a page label. The first page lagel can not be removed, only changed.

Parameters

page	the real page to remove

Member Data Documentation

DECIMAL_ARABIC_NUMERALS

const int iTextSharp.text.pdf.PdfPageLabels.DECIMAL_ARABIC_NUMERALS = 0

static

Logical pages will have the form 1,2,3,...

EMPTY

const int iTextSharp.text.pdf.PdfPageLabels.EMPTY = 5

static

No logical page numbers are generated but fixed text may still exist

LOWERCASE_LETTERS

const int iTextSharp.text.pdf.PdfPageLabels.LOWERCASE_LETTERS = 4

static

Logical pages will have the form of uppercase letters (a to z for the first 26 pages, aa to zz for the next 26, and so on)

LOWERCASE_ROMAN_NUMERALS

const int iTextSharp.text.pdf.PdfPageLabels.LOWERCASE_ROMAN_NUMERALS = 2

static

Logical pages will have the form i,ii,iii,iv,...

UPPERCASE_LETTERS

const int iTextSharp.text.pdf.PdfPageLabels.UPPERCASE_LETTERS = 3

static

Logical pages will have the form of uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on)

UPPERCASE_ROMAN_NUMERALS

const int iTextSharp.text.pdf.PdfPageLabels.UPPERCASE_ROMAN_NUMERALS = 1

static

Logical pages will have the form I,II,III,IV,...

---

The documentation for this class was generated from the following file:

• src/core/iTextSharp/text/pdf/PdfPageLabels.cs