|
Foxit PDF SDK
|
Static Public Attributes | |
| static | e_None: number static e_DecimalNums: number static e_UpperRomanNums: number static e_LowerRomanNums: number static e_UpperLetters: number static e_LowerLetters: number constructor(document) {} IsEmpty() {} GetPageLabelTitle(page_index) {} HasPageLabel(page_index) {} GetPageLabelStyle(page_index) {} GetPageLabelPrefix(page_index) {} GetPageLabelStart(page_index) {} SetPageLabel(page_index |
| Enumeration for page label style. More... | |
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 (PDF 1.3) to identify each page visually on the screen or in print. Page label titles and page indices need not coincide: the indexes are fixed, running consecutively through the document starting from 0 for the first page, but the label titles 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 0 and a page label title of i, the twelfth page would have index 11 and label title xii, and the thirteenth page would have index 12 and label title 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 (as numbering format), 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-; the resulting page labels would be A-1, A-2, and so on. Please refer to Section 8.3.1 "Page Labels" in <PDF Reference 1.7> for more details.
This class can be used to get page label full title directly, get information of a page label (as numbering format), set or add a new page label, and so on.
|
static |
Enumeration for page label style.
Values of this enumeration should be used alone.
Page label style: no numbering style.
This means page labels consist solely of a label prefix with no numeric portion.