Guides

Bookmarks

Bookmarks are a navigation tool in PDF documents that allow users to quickly jump to specific pages or locations in the document. Bookmarks are typically displayed in the sidebar or panel of a document reader, and users can quickly access relevant content by clicking on bookmarks. Bookmarks can be added manually or automatically generated based on the document structure.

Display Bookmarks

List<CPDFBookmark> bookmarks = await document.getBookmarks();

Add Bookmark

 bool result = await document.addBookmark(title: 'My Bookmark', pageIndex: 0);

Edit Bookmark

List<CPDFBookmark> bookmarks = await document.getBookmarks();
  if (bookmarks.isNotEmpty) {
    CPDFBookmark bookmark = bookmarks.first;
    bookmark.setTitle('Updated Title');
    bool result = await document.updateBookmark(bookmark);
  }

Delete Bookmark

final pageIndex = 0;
bool result = await document.removeBookmark(pageIndex);

Check if Bookmark Exists

final pageIndex = 0;
bool exists = await document.hasBookmark(pageIndex);