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

DynaPDF Manual - Page 525

Previous Page 524   Index   Next Page 526

Function Reference
Page 525 of 750
This makes it possible to create the link, also if you don't have the required information to create the
named destination at this point. If the named destination does not exist when the file is closed then
the link does nothing. See also, CreateNamedDest().
Return values:
If the function succeeds the return value is the annotation handle, a value greater or equal zero. If the
function fails the return value is a negative error code.
PageLinkEx
Syntax:
SI32 pdfPageLinkEx(
const PPDF* IPDF,
// Instance pointer
double PosX,
// X-Coordinate of bounding rectangle
double PosY,
// Y-Coordinate of bounding rectangle
double Width,
// Width of bounding rectangle
double Height,
// Height of bounding rectangle
TDestType DestType, // see below
UI32 DestPage,
// Destination page
double a,
// Various, depends on destination type
double b,
// Various, depends on destination type
double c,
// Various, depends on destination type
double d)
// Various, depends on destination type
typedef enum
{
dtXY_Zoom,
// Three parameters (a, b, c) -> (X, Y, Zoom)
dtFit,
// No parameters
dtFitH_Top,
// One parameter
(a)
dtFitV_Left, // One parameter
(a)
dtFit_Rect,
// Four parameters (left, bottom, right, top)
dtFitB,
// No parameters
dtFitBH_Top, // One parameter
(a)
dtFitBV_Left // One parameter
(a)
}TDestType;
The function adds a page link to the current open page. The parameter DestPage specifies the
destination page which should be opened (the page number). The function does not check whether
the destination page exists; it can be created later. If the destination page is not created before the
document is closed, it will be set to the first page of the document.
If the coordinate system is bottom-up the point PosX, PosY defines the lower left corner of the
bounding rectangle. If the coordinate system is top-down it defines the upper left corner.
The border of the link annotation is drawn by using the current line width, stroke color and line dash
pattern. If the link should appear without a border set the line width to zero beforehand.
When clicking on a link annotation the rectangle is highlighted, that is a simple visual effect. Several
highlight modes are supported, see SetLinkHighlightMode() for further information.
 

Previous topic: PageLink3

Next topic: ParseContent