SetOutlineDestinationZoom

Outlines

Description

Sets the destination of an outline item (bookmark) to a specific postion on a page, and sets the zoom percentage of the document.

Syntax

Delphi

function TPDFlib.SetOutlineDestinationZoom(OutlineID, DestPage: Integer; DestPosition: Double; Zoom: Integer): Integer;

ActiveX

Function PDFlib::SetOutlineDestinationZoom(OutlineID As Long, DestPage As Long, DestPosition As Double, Zoom As Long) As Long

DLL

int DLSetOutlineDestinationZoom(int InstanceID, int OutlineID, int DestPage, double DestPosition, int Zoom);

Parameters

OutlineIDThe ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID.
DestPageThe page number that this outline should link to
DestPositionThe vertical position on the page that the outline should link to. Specifying a point at the bottom of the page will result in the next page being shown - it is better to link to a point at the top of the page.
ZoomThe zoom factor to show the target page at: 0..1600 = Zoom percentage -1 = Fit in window -2 = Fit width

Return values

0The OutlineID was invalid Destination set successfull
1