Class PDFNet.PageLabel
PDFNet.PageLabel
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.PageLabel(mp_obj, m_first_page, m_last_page)
PDF page labels can be used to describe a page.
|
| Method Attributes | Method Name and Description |
|---|---|
|
assign(right)
Assignment operator
|
|
|
compare(d)
Compares two PageLabel-s for equality.
|
|
| <static> |
PDFNet.PageLabel.create(doc, style, prefix, start_at)
Creates a new PageLabel.
|
| <static> |
PDFNet.PageLabel.createFromObj(l, first_page, last_page)
Create a PageLabel and initialize it using given Cos/SDF object.
|
|
getLabelTitle(page_num)
|
|
|
getStart()
|
|
|
getStyle()
|
|
|
isValid()
|
|
|
setPrefix(prefix)
|
|
|
setStart(start_at)
|
|
|
setStyle(style)
Sets the numbering style for the label.
|
Class Detail
PDFNet.PageLabel(mp_obj, m_first_page, m_last_page)
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",
- Parameters:
- mp_obj
- m_first_page
- m_last_page
Method Detail
assign(right)
Assignment operator
- Parameters:
- {pagelabel} right
- (generated documentation)
{[ERROR]}
compare(d)
Compares two PageLabel-s for equality. The comparison will return true
only if both labels share the same underlying SDF/Cos object.
Two labels are also equivalent if they have the same style, starting
number (numeric value of the first page associated with the label),
and prefix strings which are the same byte-for-byte.
- Parameters:
- {pagelabel} d
- (generated documentation)
- Returns:
- {[ERROR]} A promise that resolves to an unknown type (generated documentation)
<static>
{pagelabel}
PDFNet.PageLabel.create(doc, style, prefix, start_at)
Creates a new PageLabel.
- Parameters:
- {SDFDoc} doc
- A document to which the page label is added.
- {number} style
- The numbering style for the label.
- {string} prefix
- The string used to prefix the numeric portion of the page label.
- {number} start_at
- the value to use when generating the numeric portion of the first label in this range; must be greater than or equal to 1.
- Returns:
- {pagelabel} A promise that resolves to newly created PageLabel object.
<static>
{pagelabel}
PDFNet.PageLabel.createFromObj(l, first_page, last_page)
Create a PageLabel and initialize it using given Cos/SDF object.
- Parameters:
- {Obj} l
- (generated documentation)
- {number} first_page
- (generated documentation)
- {number} last_page
- (generated documentation)
- Returns:
- {pagelabel} A promise that resolves to an object of type: "pagelabel" (generated documentation)
{number}
getFirstPageNum()
- Returns:
- {number} A promise that resolves to the first page in the range associated with this label or -1 if the label is not associated with any page.
{string}
getLabelTitle(page_num)
- Parameters:
- {number} page_num
- (generated documentation)
- Returns:
- {string} A promise that resolves to the full label title that is in effect for the given page. If there is no label object in effect, this method returns an empty string.
{number}
getLastPageNum()
- Returns:
- {number} A promise that resolves to the last page in the range associated with this label or -1 if the label is not associated with any page.
{string}
getPrefix()
- Returns:
- {string} A promise that resolves to the string used to prefix the numeric portion of the page label
{Obj}
getSDFObj()
- Returns:
- {Obj} A promise that resolves to the pointer to the underlying SDF/Cos object.
{number}
getStart()
- Returns:
- {number} A promise that resolves to the value to use when generating the numeric portion of the first label in this range; must be greater than or equal to 1.
{number}
getStyle()
Return value enum:
PDFNet.PageLabel.Style = {
e_decimal : 0
e_roman_uppercase : 1
e_roman_lowercase : 2
e_alphabetic_uppercase : 3
e_alphabetic_lowercase : 4
e_none : 5
}
- Returns:
- {number} A promise that resolves to page numbering style.
{boolean}
isValid()
- Returns:
- {boolean} A promise that resolves to whether this is a valid (non-null) PageLabel. If the function returns false the underlying SDF/Cos object is null or is not valid and the PageLabel object should be treated as null as well.
setPrefix(prefix)
- Parameters:
- {string} prefix
- the string used to prefix the numeric portion of the page label.
setStart(start_at)
- Parameters:
- {number} start_at
- the value to use when generating the numeric portion of the first label in this range; must be greater than or equal to 1.
setStyle(style)
Sets the numbering style for the label.
- Parameters:
- {number} style
- the numbering style for the label. You may use label style to customize the page numbering schemes used throughout a document. There are three numbering formats: decimal (often used for normal page ranges) roman (often used for front matter such as a preface) alphabetic (often used for back matter such as appendices)