Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
DynaPDF.SetBookmarkDest
Sets or changes the destination of a bookmark.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
DynaPDF | 4.0 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "DynaPDF.SetBookmarkDest"; PDF; BookmarkHandle; DestType; a; b; c; d ) More
Parameters
Parameter | Description | Example |
---|---|---|
The PDF reference returned from DynaPDF.New. | ||
BookmarkHandle | The reference number for the bookmark. Either returned by one of the add/insert functions or just counting from 0 to DynaPDF.GetBookmarkCount-1. | $BookmarkHandle |
DestType | The destination type. Must be XY_Zoom, Fit, FitH_Top, FitV_Left, Fit_Rect, FitB, FitBH_Top or FitBV_Left. | |
a | The first parameter. | $a |
b | The first parameter. | $b |
c | The first parameter. | $c |
d | The first parameter. | $d |
Result
Returns OK or error.
Description
Sets or changes the destination of a bookmark.The parameter BookmarkHandle must be a valid bookmark handle. The destination page will not be changed by this function it must be set correctly with the function DynaPDF.AddBookmark. If it should be changed use the function DynaPDF.ChangeBookmark.
The destination created by this function allows jumping to a specific position in a document instead of simply opening a page such as a normal bookmark does.
See dynapdf_help.pdf manual file for details.
See also SetBookmarkDest function in DynaPDF manual.
See also
- DynaPDF.AddBookmark
- DynaPDF.ChangeBookmark
- DynaPDF.GetBookmark
- DynaPDF.GetBookmarkCount
- DynaPDF.New
- DynaPDF.SetBookmarkStyle
This function checks for a license.
Created 18th August 2014, last changed 18th August 2014
