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: 11.4   11.5   12.0   12.1   12.2   12.3   12.4   12.5   13.0   13.1    Statistic    FMM    Blog  

DynaPDF.GetBookmarksAsJSON

Queries all bookmarks as JSON array.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 10.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.GetBookmarksAsJSON"; PDF { ; Flags } )   More

Parameters

Parameter Description Example Flags
PDF The PDF reference returned from DynaPDF.New. $pdf
Flags Pass 1 to get a flat list. 0 Optional

Result

Returns JSON or error.

Description

Queries all bookmarks as JSON array.
See TBookmark structure in DynaPDF help, which we convert to JSON for you.
Hierarchy is preserved, so you find the child entries in an entry named "children".

Keys include: Color, DestPage, DestPos, DestType, Open, Parent, Style, Unicode, TitleLen, Title, Children and Index.
If flat option is used, the Children array will include the indexes of children instead of objects describing those.

When DynaPDF library is version 4.0.71.204 or newer, we include NamedDest and Action values.

See also GetBookmarksAsJSON function in DynaPDF manual.

Examples

Query JSON:

Set Variable [ $JSON; Value: MBS( "DynaPDF.GetBookmarksAsJSON"; PDF ) ]

See also

Release notes

Example Databases

Blog Entries

This function checks for a paid license.

Created 16th September 2020, last changed 24th January 2023


DynaPDF.GetBookmarkCount - DynaPDF.GetBorderStyle

💬 Ask a question or report a problem


Start Chat