Topics   All   Mac OS X (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server (Not)   Client   Old   Guides   Examples
New in version: 6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4   7.5   7.6    Statistic  

DynaPDF.InsertBookmark

Inserts a bookmark in an existing outline tree.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
DynaPDF 4.0 Yes Yes Yes Yes Yes

MBS( "DynaPDF.InsertBookmark"; PDF; Title; Parent; DestPage { ; Open; AddChildren } )

Parameters

Parameter Description Example value
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 Optional
Optionally, open or close the node when it contains children. Default 0.
0
AddChildren Optional
Optionally, add all bookmarks below the new one as children. Default 0.
0

Result

Returns new bookmark handle or error.

Description

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


DynaPDF.Initialize   -   DynaPDF.InsertBookmarkEx

Feedback: Report problem or ask question.




Links
MBS Xojo PDF Plugins