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.

Syntax

Delphi

function TDebenuPDFLibrary1811.AddPageLabels(Start, Style, Offset: Integer; 
  Prefix: WideString): Integer;

ActiveX

Function DebenuPDFLibrary1811.PDFLibrary::AddPageLabels(Start As Long,
  Style As Long, Offset As Long, Prefix As String) As Long

DLL

int DPLAddPageLabels(int InstanceID, int Start, int Style, int Offset,
  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