Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
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 |
---|---|---|
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 |
Selector | Which information to query. | "Title" |
Result
Returns value or error.
Description
Returns the properties of a bookmark.This allows you to learn to which page the bookmark refers to.
Selectors can be:
Color | Bookmark color (PDF 1.4) |
DestPage | Destination page |
DestPos | Destination position |
DestType | Destination type (see DynaPDF.SetBookmarkDest) |
Open | 1 if the bookmark appears open |
Parent | Parent bookmark if any or -1 |
Style | Text style. a combination of 1 for italic and 2 for bold. |
Title | Title text. |
TitleLen | Title length in characters. |
NamedDest | Optional name of a named destination. If set, DestPage, DestPos, and DestType were already taken from the destination if it was found. |
Action | Action handle or -1 if not set. |
When DynaPDF library is version 4.0.71.204 or newer, you can query NamedDest and Action values.
See also GetBookmark function in DynaPDF manual.
Examples
query title of a bookmark:
MBS( "DynaPDF.GetBookmark"; $PDF; $BookmarkHandle; "Title" )
See also
- DynaPDF.AddBookmark
- DynaPDF.AddBookmarkEx
- DynaPDF.ChangeBookmark
- DynaPDF.DeleteBookmark
- DynaPDF.FindBookmark
- DynaPDF.GetBookmarkCount
- DynaPDF.InsertBookmark
- DynaPDF.New
- DynaPDF.SetBookmarkDest
- DynaPDF.SetBookmarkStyle
Release notes
- Version 13.1
- Updated DynaPDF.GetBookmark and DynaPDF.GetBookmarksAsJSON functions to return Action and NamedDest properties.
- Version 10.5
Blog Entries
This function checks for a license.
Created 18th August 2014, last changed 24th January 2023