DynaPDF Manual - Page 595

Previous Page 594   Index   Next Page 596

Function Reference
Page 595 of 839
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.
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
// Three parameters (a, b, c) -> (X, Y, Zoom)
// No parameters
// One parameter
dtFitV_Left, // One parameter
// Four parameters (left, bottom, right, top)
// No parameters
dtFitBH_Top, // One parameter
dtFitBV_Left // One parameter
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.
The destination created by this annotation allows jumping to a specific position in a document
instead of simply opening the page such as PageLink() does.

Previous topic: PageLink2, PageLink3

Next topic: ParseContent