AddPageLabels
Page properties
Description
Adds a range of page labels to the selected document. A range starting from page 1 must be present in the document for the page labels to display correctly. Page labels are a PDF 1.3 catalog feature; calling this method on a lower-version document raises the effective PDF version to 1.3 unless the save version is explicitly locked.
Existing label ranges are preserved when a loaded document stores its labels in a number tree with child nodes; inserting or replacing a range remains effective after saving and reloading the document
Syntax
Delphi
Function TPDFlib.AddPageLabels(Start, Style, Offset: Integer; Const Prefix: WideString): Integer;ActiveX
Function PDFlib::AddPageLabels(Start As Long, Style As Long, Offset As Long, Prefix As String) As LongDLL
int DLAddPageLabels(int InstanceID, int Start, int Style, int Offset, const wchar_t * Prefix);Parameters
| Start | The starting page for the range of page labels |
|---|---|
| Style | 0 = No numbers 1 = Decimal arabic numerals 2 = Uppercase roman numerals 3 = Lowercase roman numerals 4 = Uppercase letters (A to Z for first 26 pages, AA to ZZ for next 26, etc.) 5 = Lowercase letters (a to z for first 26 pages, aa to zz for next 26, etc.) |
| Offset | The value of the numeric portion for the first page label in the range. Subsequent values will be numbered sequentially from this value, which much be greater than or equal to 1. |
| Prefix | The prefix for the page labels in this range. |
Return values
| 0 | The Style parameter was out of range. |
|---|---|
| 1 | The page label range was added successfully. |