Monkeybread Software - MBS FileMaker Plugin: DynaPDF.GetPageLabel

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

DynaPDF.GetPageLabel

Retrieves the properties of a page label.

Component	Version	macOS	Windows	Linux	Server	iOS SDK
DynaPDF	5.0	✅ Yes	✅ Yes	✅ Yes	✅ Yes	✅ Yes

MBS( "DynaPDF.GetPageLabel"; PDF; Index; Selector ) More

Parameters

Parameter Description Example

PDF The PDF reference returned from DynaPDF.New. $pdf

Index Page label handle or array index. $index

Selector What value to query. Can be StartRange, Format, FirstPageNum or Prefix. "Prefix"

Parameter	Description	Example
PDF	The PDF reference returned from DynaPDF.New.	$pdf
Index	Page label handle or array index.	$index
Selector	What value to query. Can be StartRange, Format, FirstPageNum or Prefix.	"Prefix"

Result

Returns value or error.

Description

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 queried with the function DynaPDF.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 subsequent pages through DynaPDF.GetPageCount. The member FirstPageNum represents the numeric portion of the first page label in the range. Subsequent pages are numbered sequentially from this value.
Page label format can be: DecimalArabic, UppercaseRoman, LowercaseRoman, UppercaseLetters, LowercaseLetters or None.

See also GetPageLabel function in DynaPDF manual.