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

DynaPDF Manual - Page 424

Previous Page 423   Index   Next Page 425

Function Reference
Page 424 of 750
GetPageAnnotEx
Syntax:
LBOOL pdfGetPageAnnotEx(
const PPDF* IPDF, // Instance pointer
UI32 Index,
// Array index in the page
struct TPDFAnnotationEx ADDR Annot) // Structure to be filled
The function retrieves the most important properties of an annotation like GetAnnotEx(). The
parameter Index must be the array index of the page in which the annotation is used. To enumerate
the annotations of a page execute the function in a loop from 0 to GetPageAnnotCount() - 1. See
GetAnnotEx() for further information.
Return Values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
GetPageAnnotCount
Syntax:
SI32 pdfGetPageAnnotCount(
const PPDF* IPDF) // Instance pointer
The function returns the number of annotations which are used by a page. The page must be opened
with EditPage() before the function can be used. The annotations of the page can be accessed with
GetPageAnnotEx().
Return values:
If the function succeeds the return value is the number of annotations which are used by a page. If
the function fails the return value is a negative error code.
GetPageBBox (Rendering Engine)
Syntax:
LBOOL pdfGetPageBBox(
IPGE* PagePtr,
// Pointer of a page object
TPageBoundary Type,
// The bounding box that should be returned
struct TFltRect* BBox) // Out -> The bounding box
The function returns a bounding box of a page. The parameter PagePtr must be a valid page pointer
that was returned by GetPageObject(). The function accesses the page object without any overhead,
and hence, is very fast.
Note that all bounding boxes with exception of the media box are optional and maybe not available.
When the bounding box is not available the function initializes the parameter BBox with zero and
returns false.
 

Previous topic: GetPageAnnot (obsolete)

Next topic: GetPageField (obsolete)