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

DynaPDF Manual - Page 428

Previous Page 427   Index   Next Page 429

Function Reference
Page 428 of 750
GetPageLabel
Syntax:
LBOOL pdfGetPageLabel(
const PPDF* IPDF,
// Instance pointer
UI32 Index,
// Page label handle or array index
struct TPDFPageLabel* Label) // Page label structure
struct TPDFPageLabel
{
UI32
StartRange;
// Number of the first page in the
// range. If no further label follows,
// the last page in the range is
// pdfGetPageCount(). The first page is
// denoted by 1.
TPageLabelFormat Format;
// Number format to be used.
SI32
FirstPageNum; // First page number to be displayed in
// the page label. Subsequent pages are
// numbered sequentially from this
// value.
char*
Prefix;
// Optional prefix
UI32
PrefixLen;
// Length of the prefix in characters
LBOOL
PrefixUni;
// Prefix is a Unicode string?
};
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 retrieves the properties of a page label. The parameter Index must be the array index of
the page label. The number of available page labels can be determned with the function
GetPageLabelCount().
A page label is used to construct a format string. The start range identifies the first page to which this
label applies. If no further page labels follow, the label is applied to all susequent pages through
GetPageCount(). The member FirstPageNum represents the numeric portion of the first page label in
the range. Subsequent pages are numbered sequentially from this value.
Return values:
In the function succeeds the return value is 1. If the function fails the return value is 0.
 

Previous topic: GetPageHeight

Next topic: GetPageNum