PTPageLabel

@interface PTPageLabel : NSObject

PDF page labels can be used to describe a page. This is used to allow for non-sequential page numbering or the addition of arbitrary labels for a page (such as the inclusion of Roman numerals at the beginning of a book). PDFNet PageLabel object can be used to specify the numbering style to use (for example, upper- or lower-case Roman, decimal, and so forth), the starting number for the first page, and an arbitrary prefix to be pre-appended to each number (for example, “A-” to generate “A-1”, “A-2”, “A-3”, and so forth.)

PageLabel corresponds to the PDF Page Label object (Section 8.3.1, ‘Page Labels’ in the PDF Reference Manual.

Each page in a PDF document is identified by an integer page index that expresses the page’s relative position within the document. In addition, a document may optionally define page labels to identify each page visually on the screen or in print. Page labels and page indices need not coincide: the indices are fixed, running consecutively through the document starting from 1 for the first page, but the labels can be specified in any way that is appropriate for the particular document. For example, if the document begins with 12 pages of front matter numbered in roman numerals and the remainder of the document is numbered in Arabic, the first page would have a page index of 1 and a page label of i, the twelfth page would have index 12 and label xii, and the thirteenth page would have index 13 and label 1.

For purposes of page labeling, a document can be divided into labeling ranges, each of which is a series of consecutive pages using the same numbering system. Pages within a range are numbered sequentially in ascending order. A page’s label consists of a numeric portion based on its position within its labeling range, optionally preceded by a label prefix denoting the range itself. For example, the pages in an appendix might be labeled with decimal numeric portions prefixed with the string “A-” and the resulting page labels would be “A-1”, “A-2”,

@note There is no default numbering style; if no ‘S’ (Style) entry is present, page labels consist solely of a label prefix with no numeric portion. For example, if the ‘P’ entry (Prefix) specifies the label prefix “Appendix”, each page is simply labeled “Appendix” with no page number. If the ‘P’ entry is also missing or empty, the page label is an empty string.

Sample code (See PableLabelsTest sample project for examples):

 // Create a page labeling scheme that starts with the first page in
 // the document (page 1) and is using uppercase roman numbering
 // style.
 doc.SetPageLabel(1, PageLabel::Create(doc, PageLabel::e_roman_uppercase, "My Prefix ", 1));

 // Create a page labeling scheme that starts with the fourth page in
 // the document and is using decimal Arabic numbering style.
 // Also the numeric portion of the first label should start with number
 // 4 (otherwise the first label would be "My Prefix 1").
 PageLabel L2 = PageLabel::Create(doc, PageLabel::e_decimal, "My Prefix ", 4);
 doc.SetPageLabel(4, L2);

 // Create a page labeling scheme that starts with the seventh page in
 // the document and is using alphabetic numbering style. The numeric
 // portion of the first label should start with number 1.
 PageLabel L3 = PageLabel::Create(doc, PageLabel::e_alphabetic_uppercase, "My Prefix ", 1);
 doc.SetPageLabel(7, L3);

 // Read page labels from an existing PDF document.
 PageLabel label;
 for (int i=1; i<=doc.GetPageCount(); ++i) {
 label = doc.GetPageLabel(i);
 if (label.IsValid()) {
   UString title = label.GetLabelTitle(i);
 }