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.1   6.2   6.3   6.4   6.5   7.0   7.1   7.2   7.3   7.4    Statistic  

DynaPDF.ChangeBookmark

Changes an existing bookmark.

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

MBS( "DynaPDF.ChangeBookmark"; PDF; BookmarkHandle; Title; Parent; DestPage; Open )

Parameters

Parameter Description Example value
PDF The PDF reference returned from DynaPDF.New. $pdf
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
Title New title "Hello"
Parent New parent bookmark. -1
DestPage New destination page 5
Open Open the bookmark? 0

Result

Returns OK or error.

Description

Changes an existing bookmark.
There is no difference between imported bookmarks and bookmarks which were created with DynaPDF. The parameter ABmk requires a valid bookmark handle. A bookmark handle is a simple array index ranging from zero to DynaPDF.GetBookmarkCount -1.
The parameter Title can be "" if it should be deleted. The parameter Open will be ignored if the bookmark contains no children.
The function does not check whether the destination page exists at the time the bookmark is changed. If the destination page does not exist when file is closed then it will be set to page 1.

To get the handle of a specific bookmark use the functions DynaPDF.FindBookmark and DynaPDF.FindNextBookmark to find the bookmark.
It is also possible to enumerate all bookmarks by using DynaPDF.GetBookmarkCount and DynaPDF.GetBookmark until the used bookmark was found (see DynaPDF.GetBookmark for further information).

See also ChangeBookmark function in DynaPDF manual.

Examples

Change the bookmark with new title and new page:

MBS( "DynaPDF.ChangeBookmark"; $PDF; $BookmarkHandle; "Hello World"; $NewParent; 6; 0 )

See also


DynaPDF.ChangeAnnotPos   -   DynaPDF.ChangeFont

Feedback: Report problem or ask question.




Links
MBS Xojo tutorial videos