SetOutlineDestinationFull
Outlines
Description
Sets the destination of an outline item (bookmark) to a specific postion and zoom percentage.
Syntax
Delphi
function TPDFlib.SetOutlineDestinationFull(OutlineID, DestPage, Zoom, DestType: Integer; Left, Top, Right, Bottom: Double): Integer;ActiveX
Function PDFlib::SetOutlineDestinationFull(OutlineID As Long, DestPage As Long, Zoom As Long, DestType As Long, Left As Double, Top As Double, Right As Double, Bottom As Double) As LongDLL
int DLSetOutlineDestinationFull(int InstanceID, int OutlineID, int DestPage, int Zoom, int DestType, double Left, double Top, double Right, double Bottom);Parameters
| OutlineID | The ID of the outline as returned by the NewOutline function. Alternatively, use the GetOutlineID function to get a valid outline ID. |
|---|---|
| DestPage | The page number that this outline item links to The zoom percentage to use when the outline destination is opened, valid values from 0 to 6400. Only used for DestType = 1, should be set to 0 for other DestTypes. |
| Zoom | |
| DestType | 1 = "XYZ" - the target page is positioned at the point specified by the Left and Top parameters. The Zoom parameter specifies the zoom percentage. 2 = "Fit" - the entire page is zoomed to fit the window. None of the other parameters are used and should be set to zero. 3 = "FitH" - the page is zoomed so that the entire width of the page is visible. The height of the page may be greater or less than the height of the window. The page is positioned at the vertical position specified by the Top parameter. 4 = "FitV" - the page is zoomed so that the entire height of the page can be seen. The width of the page may be greater or less than the width of the window. The page is positioned at the horizontal position specified by the Left parameter. 5 = "FitR" - the page is zoomed so that a certain rectangle on the page is visible. The Left, Top, Right and Bottom parameters define the rectangular area on the page. 6 = "FitB" - the page is zoomed so that it's bounding box is visible. 7 = "FitBH" - the page is positioned vertically at the position specified by the Top parameter. The page is zoomed so that the entire width of the page's bounding box is visible. 8 = "FitBV" - the page is positioned at the horizontal position specified by the Left parameter. The page is zoomed just enough to fit the entire height of the bounding box into the window. The horizontal position used by DestType = 1, 4, 5 and 8 |
| Left | |
| Top | The vertical position used by DestType = 1, 3, 5 and 7 |
| Right | The horizontal position of the righthand edge of the rectangle. Used by DestType = 5 |
| Bottom | The horizontal position of the bottom of the rectangle. Used by DestType = 5 |
Return values
| 0 | The outline destination could not be set. The usually indicates that the Zoom or DestType parameters are out of range or the OutlineID is invalid. |
|---|---|
| 1 | The outline destination was set successfully |