Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

DynaPDF.FindBookmark

Searches for a bookmark in the document outline tree.

Component Version macOS Windows Linux Server iOS SDK
DynaPDF 4.0 ✅ Yes ✅ Yes ✅ Yes ✅ Yes ✅ Yes
MBS( "DynaPDF.FindBookmark"; PDF; DestPage; Title )   More

Parameters

Parameter Description Example
PDF The PDF reference returned from DynaPDF.New. $pdf
DestPage Destination page used by the bookmark or -1. -1
Title The title of the bookmark or a part of it. "Chapter 1"

Result

Returns bookmark handle or error.

Description

Searches for a bookmark in the document outline tree.
If the parameter DestPage is greater zero the function returns the handle of the first bookmark that uses this page number as destination page.
If DestPage is smaller 1 the function returns the handle of the first bookmark that contains the substring Title in the bookmark title. The substring Title is compared non-case-sensitive.
The parameter Title can be "", the function searches for bookmarks with no title in this case. To search for the next bookmark with the same search parameters call DynaPDF.FindNextBookmark.
It is safe to delete a found bookmark with DynaPDF.DeleteBookmark and continue the search run with DynaPDF.FindNextBookmark.

If a bookmark can be found the return value is the bookmark handle, a value greater or equal zero. If no bookmark can be found the return value is -1. If an error occurred, the return value is an error.

See also FindBookmark function in DynaPDF manual.

See also

This function checks for a license.

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


DynaPDF.FileLink - DynaPDF.FindEmbeddedFile