AddPageLabelsA
Page properties
Description
The trailing A denotes the ANSI (char) DLL entry point; the ActiveX/COM surface exposes only the Unicode form. Behaviour is identical to AddPageLabels and string arguments are interpreted using the current SetAnsiMode code page
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 catalogue feature; calling this method on a lower-version document raises the effective PDF version to 1.3 unless the save version is explicitly locked
Syntax
Delphi
Function DLAddPageLabelsA(InstanceID, Start, Style, Offset: Integer; Prefix: PAnsiChar): Integer;
DLL
int DLAddPageLabelsA(int InstanceID, int Start, int Style, int Offset, const char * 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. |