Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 10.1   10.2   10.3   10.4   10.5   11.0   11.1   11.2   11.3   11.4    Statistic    FMM    Blog  

DynaPDF.GetBookmark

Returns the properties of a bookmark.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 4.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetBookmark"; PDF; BookmarkHandle; Selector )   More

Parameters

Parameter Description Example
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
Selector Which information to query. "Title"

Result

Returns value or error.

Description

Returns the properties of a bookmark.
Selectors can be:
ColorBookmark color (PDF 1.4)
DestPageDestination page
DestPosDestination position
DestTypeDestination type (see DynaPDF.SetBookmarkDest)
Open1 if the bookmark appears open
ParentParent bookmark if any or -1
StyleText style. a combination of 1 for italic and 2 for bold.
TitleTitle text.
TitleLenTitle length in characters.

See also GetBookmark function in DynaPDF manual.

Examples

query title of a bookmark:

MBS( "DynaPDF.GetBookmark"; $PDF; $BookmarkHandle; "Title" )

See also

Release notes

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


DynaPDF.GetBBox - DynaPDF.GetBookmarkCount

Feedback: Report problem or ask question.