DynaPDF Manual - Page 593

Previous Page 592   Index   Next Page 594

Function Reference

Page 593 of 839

PageLink

Syntax:

SI32 pdfPageLink(

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

UI32 DestPage)

// Destination page

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 does not exist when the

document is closed it will be set to the first page.

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.

Remarks:

The destination page is always opened at the top corner. More precise destinations can be created

with the function PageLinkEx(). Page links can also be used to execute an action. The destination

page is ignored in the latter case, the annotation works then like a button.

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.

Previous topic: Error handling

Next topic: PageLink2, PageLink3