Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old


Inserts a bookmark in an existing outline tree.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 4.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.InsertBookmark"; PDF; Title; Parent; DestPage { ; Open; AddChildren } )   More


Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
Title Bookmark title "Chapter 2"
Parent Immediate parent bookmark -1
DestPage Destination page that should be opened. 5
Open Optionally, open or close the node when it contains children. Default 0. 0 Optional
AddChildren Optionally, add all bookmarks below the new one as children. Default 0. 0 Optional


Returns new bookmark handle or error.


Inserts a bookmark in an existing outline tree.
It sets also the page mode to UseOutlines (see DynaPDF.SetPageMode). If the outline tree should not be shown when opening the document then set the page mode back to UseNone or another value before closing the document.
Parent can be the handle of the parent bookmark after the new bookmark should be inserted or -1. If Parent is set to -1 the bookmark is inserted as the first root node in the outline tree.
If the parameter AddChildren is set to true, the bookmarks below the new one are added as children to the new bookmark. This can be useful when merging PDF files and if the bookmarks from each PDF file should be separated.
Notice: When inserting a bookmark the handles of all bookmarks below the new one are incremented by one.

See also InsertBookmark function in DynaPDF manual.

See also

This function checks for a license.

Created 18th August 2014, last changed 18th August 2014

DynaPDF.InsertBarcode - DynaPDF.InsertBookmarkEx