Section:

User-defined bookmarks in Android

User-defined bookmarks are an Apryse specific feature that may not show in other PDF viewer applications. If you want to manage PDF bookmarks so that they can be processed in other standard PDF viewers, see the document outline guide .

The UserBookmarkDialogFragment displays a list of user-defined bookmarks that can be used to navigate the document.

Apryse Docs Image

Show user bookmark dialog

To show a user bookmark dialog fragment in your activity, create a new instance of UserBookmarkDialogFragment by calling newInstance() and setting the PDFViewCtrl:

1BookmarksDialogFragment showBookmarksDialog(FragmentManager fragmentManager, PDFViewCtrl pdfViewCtrl) {
2    DialogFragmentTab userBookmarksDialog = new DialogFragmentTab(
3        UserBookmarkDialogFragment.class,
4        BookmarksTabLayout.TAG_TAB_BOOKMARK,
5        null,
6        "User Bookmarks",
7        "Bookmarks Dialog",
8        null);
9    ArrayList<DialogFragmentTab> dialogFragmentTabs = new ArrayList<>();
10    dialogFragmentTabs.add(userBookmarksDialog);
11
12    BookmarksDialogFragment bookmarksDialog = BookmarksDialogFragment.newInstance();
13    bookmarksDialog.setPdfViewCtrl(pdfViewCtrl)
14        .setDialogFragmentTabs(dialogFragmentTabs);
15    bookmarksDialog.setStyle(DialogFragment.STYLE_NO_TITLE, R.style.PDFTronAppTheme);   
16    bookmarksDialog.show(fragmentManager, "bookmarks_dialog");
17    return bookmarksDialog;
18}

Listener

You can set a listener to be notified when a user bookmark is clicked by calling setUserBookmarkListener(UserBookmarkDialogListener).

Read-only

If the document has write access, users can add new user bookmarks using floating action button. To specify whether the document is read-only call setReadOnly(boolean).

Import and export

It is possible to import and export user bookmarks in JSON format. Typical use case is to save and load the user bookmarks JSON from a server.

The user bookmark JSON is a dictionary with page indices as keys and the bookmark title as the values. For example: {"0":"Bookmark 1","2":"Bookmark 2"}. Behaviour is undefined otherwise. Note that the page indices will be 0-indexed similar to XFDF.

1// import
2BookmarkManager.importPdfBookmarks(PDFViewCtrl, String);
3// export
4BookmarkManager.exportPdfBookmarks(PDFDoc);

Did you find this helpful?

Trial setup questions?

Ask experts on Discord

Need other help?

Contact Support

Pricing or product questions?

Contact Sales