THotPDF.SetLoadedPageLabel Method
Defines a page label range for the loaded PDF starting from a specified page, setting the numbering style, prefix text, and starting number
Declaration
procedure SetLoadedPageLabel(StartPageIndex: Integer; const AStyle: AnsiString; const APrefix: AnsiString; AStart: Integer);
Unit
HPDFDoc
Parameters
| Name | Purpose |
|---|---|
StartPageIndex | The zero-based page index where the new label range begins |
AStyle | The numbering style: 1 for decimal, 2 upper-case Roman, 3 lower-case Roman, 4 upper-case letters, 5 lower-case letters, and 0 where only the prefix is wanted |
APrefix | Optional text set ahead of each page number; bytes above 127 are read as UTF-8 |
AStart | The starting number of the range; the range's first page is numbered with this value |
Usage notes
This member returns no value
Usage notes
- The range goes into the catalog /PageLabels number tree in page order — trees split across /Kids nodes included — so viewers read the labels properly
- Calling the method a second time with the same StartPageIndex supersedes that range
- Where the document has no range beginning at the first page, a plain decimal range is added on its behalf, because the number tree has to cover page index 0 (ISO 32000-1 12.4.2)