Xojo Developer Conference
25/27th April 2018 in Denver.
MBS Xojo Conference
6/7th September 2018 in Munich, Germany.

DynaPDF Manual - Page 130

Previous Page 129   Index   Next Page 131

Function Reference
Page 130 of 750
AddPageLabel
Syntax:
SI32 pdfAddPageLabel(
const PPDF* IPDF,
// Instance pointer
UI32 StartRange,
// Page number where labelling starts
TPageLabelFormat Format, // Label format
const char* Prefix,
// Optional prefix
SI32 FirstPageNum)
// Page number to be displayed in the label
typedef enum
{
plfDecimalArabic,
// 1,2,3,4...
plfUppercaseRoman,
// I,II,III,IV...
plfLowercaseRoman,
// i,ii,iii,iv...
plfUppercaseLetters, // A,B,C,D...
plfLowercaseLetters, // a,b,c,d...
plfNone
}TPageLabelFormat;
The function creates a page label object. The parameter StartRange must be the page number where
labelling should start. The first page is denoted by 1. The parameters Prefix and FirstPageNum are
both optional. FirstPageNum represents the numeric portion of the first page label in the range. This
value is incremented on subsequent pages in the range. The value must be greater zero, otherwise it
will be ignored. Numbering of the range starts at one in this case.
FirstPage should normally be set to the same value as StartPage to achieve a continous page
numbering. Although it is possible to number each range separately, this can be very confusing for
users since the logical and physical page order is then different.
A document can contain multiple page label objects. Each of them represents a labelling range 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 labelling range, optionally preceded by a label prefix
denoting the range itself. For example, the pages in an appendix might be labelled with decimal
numeric portions prefixed with the string A; the resulting page labels would be A-1, A-2, and so on.
Remarks:
This function is implemented in an Ansi and Unicode compatible version.
Return values:
If the function succeeds the return value is the page label handle, a value greater or equal zero. If the
function fails the return value is a negative error code.
 

Previous topic: AddOutputIntentEx

Next topic: AddRasImage (Rendering Engine)