> For the complete documentation index, see [llms.txt](https://docs.apryse.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.apryse.com/android/get-started/samples/bookmarktest.md). # Bookmarks Sample Java code to use Apryse SDK for programmatically reading and editing existing outline items, and for creating new PDF bookmarks using the high-level API. Sample Java code to use Apryse SDK for programmatically reading and editing existing outline items, and for creating new PDF bookmarks using the high-level API. Learn more about our [Android SDK](/core/get-started/languages/java.md) and [PDF Editing & Manipulation Library](/core/page-manipulation/manipulation.md). {% tabs %} {% tab title="Java" %} {% code lineNumbers="true" %} ```java //--------------------------------------------------------------------------------------- // Copyright (c) 2001-2019 by PDFTron Systems Inc. All Rights Reserved. // Consult legal.txt regarding legal and license information. //--------------------------------------------------------------------------------------- package com.pdftron.android.pdfnetsdksamples.samples; import com.pdftron.android.pdfnetsdksamples.OutputListener; import com.pdftron.android.pdfnetsdksamples.PDFNetSample; import com.pdftron.android.pdfnetsdksamples.R; import com.pdftron.android.pdfnetsdksamples.util.Utils; import com.pdftron.common.PDFNetException; import com.pdftron.pdf.Action; import com.pdftron.pdf.Bookmark; import com.pdftron.pdf.Destination; import com.pdftron.pdf.FileSpec; import com.pdftron.pdf.PDFDoc; import com.pdftron.pdf.Page; import com.pdftron.sdf.Obj; import com.pdftron.sdf.SDFDoc; import java.util.ArrayList; public class BookmarkTest extends PDFNetSample { private static OutputListener mOutputListener; private static ArrayList mFileList = new ArrayList<>(); public BookmarkTest() { setTitle(R.string.sample_bookmarks_title); setDescription(R.string.sample_bookmarks_description); } @Override public void run(OutputListener outputListener) { super.run(outputListener); mOutputListener = outputListener; mFileList.clear(); printHeader(outputListener); // The following example illustrates how to create and edit the outline tree // using high-level Bookmark methods. try (PDFDoc doc = new PDFDoc((Utils.getAssetTempFile(INPUT_PATH + "numbered.pdf").getAbsolutePath()))) { doc.initSecurityHandler(); // Lets first create the root bookmark items. Bookmark red = Bookmark.create(doc, "Red"); Bookmark green = Bookmark.create(doc, "Green"); Bookmark blue = Bookmark.create(doc, "Blue"); doc.addRootBookmark(red); doc.addRootBookmark(green); doc.addRootBookmark(blue); // You can also add new root bookmarks using Bookmark.AddNext("...") blue.addNext("foo"); blue.addNext("bar"); // We can now associate new bookmarks with page destinations: // The following example creates an 'explicit' destination (see // section '8.2.1 Destinations' in PDF Reference for more details) Destination red_dest = Destination.createFit(doc.getPageIterator().next()); red.setAction(Action.createGoto(red_dest)); // Create an explicit destination to the first green page in the document green.setAction(Action.createGoto( Destination.createFit(doc.getPage(10)))); // The following example creates a 'named' destination (see // section '8.2.1 Destinations' in PDF Reference for more details) // Named destinations have certain advantages over explicit destinations. byte[] key = {'b', 'l', 'u', 'e', '1'}; Action blue_action = Action.createGoto(key, Destination.createFit(doc.getPage(19))); blue.setAction(blue_action); // We can now add children Bookmarks Bookmark sub_red1 = red.addChild("Red - Page 1"); sub_red1.setAction(Action.createGoto(Destination.createFit(doc.getPage(1)))); Bookmark sub_red2 = red.addChild("Red - Page 2"); sub_red2.setAction(Action.createGoto(Destination.createFit(doc.getPage(2)))); Bookmark sub_red3 = red.addChild("Red - Page 3"); sub_red3.setAction(Action.createGoto(Destination.createFit(doc.getPage(3)))); Bookmark sub_red4 = sub_red3.addChild("Red - Page 4"); sub_red4.setAction(Action.createGoto(Destination.createFit(doc.getPage(4)))); Bookmark sub_red5 = sub_red3.addChild("Red - Page 5"); sub_red5.setAction(Action.createGoto(Destination.createFit(doc.getPage(5)))); Bookmark sub_red6 = sub_red3.addChild("Red - Page 6"); sub_red6.setAction(Action.createGoto(Destination.createFit(doc.getPage(6)))); // Example of how to find and delete a bookmark by title text. Bookmark foo = doc.getFirstBookmark().find("foo"); if (foo.isValid()) { foo.delete(); } else { throw new Exception("Foo is not Valid"); } Bookmark bar = doc.getFirstBookmark().find("bar"); if (bar.isValid()) { bar.delete(); } else { throw new Exception("Bar is not Valid"); } // Adding color to Bookmarks. Color and other formatting can help readers // get around more easily in large PDF documents. red.setColor(1, 0, 0); green.setColor(0, 1, 0); green.setFlags(2); // set bold font blue.setColor(0, 0, 1); blue.setFlags(3); // set bold and itallic doc.save((Utils.createExternalFile("bookmark.pdf", mFileList).getAbsolutePath()), SDFDoc.SaveMode.NO_FLAGS, null); mOutputListener.println("Done. Result saved in bookmark.pdf"); } catch (Exception e) { mOutputListener.printError(e.getStackTrace()); } // The following example illustrates how to traverse the outline tree using // Bookmark navigation methods: Bookmark.GetNext(), Bookmark.GetPrev(), // Bookmark.GetFirstChild () and Bookmark.GetLastChild (). // Open the document that was saved in the previous code sample try (PDFDoc doc = new PDFDoc((Utils.createExternalFile("bookmark.pdf", mFileList).getAbsolutePath()))) { doc.initSecurityHandler(); Bookmark root = doc.getFirstBookmark(); PrintOutlineTree(root); mOutputListener.println("Done."); } catch (Exception e) { mOutputListener.printError(e.getStackTrace()); } // The following example illustrates how to create a Bookmark to a page // in a remote document. A remote go-to action is similar to an ordinary // go-to action, but jumps to a destination in another PDF file instead // of the current file. See Section 8.5.3 'Remote Go-To Actions' in PDF // Reference Manual for details. // Open the document that was saved in the previous code sample try (PDFDoc doc = new PDFDoc((Utils.createExternalFile("bookmark.pdf", mFileList).getAbsolutePath()))) { doc.initSecurityHandler(); // Create file specification (the file reffered to by the remote bookmark) Obj file_spec = doc.createIndirectDict(); file_spec.putName("Type", "Filespec"); file_spec.putString("F", "bookmark.pdf"); FileSpec spec = new FileSpec(file_spec); Action goto_remote = Action.createGotoRemote(spec, 5, true); Bookmark remoteBookmark1 = Bookmark.create(doc, "REMOTE BOOKMARK 1"); remoteBookmark1.setAction(goto_remote); doc.addRootBookmark(remoteBookmark1); // Create another remote bootmark, but this time using the low-level SDF/Cos API. // Create a remote action Bookmark remoteBookmark2 = Bookmark.create(doc, "REMOTE BOOKMARK 2"); doc.addRootBookmark(remoteBookmark2); Obj gotoR = remoteBookmark2.getSDFObj().putDict("A"); { gotoR.putName("S", "GoToR"); // Set action type gotoR.putBool("NewWindow", true); // Set the file specification gotoR.put("F", file_spec); // jump to the first page. Note that pages are indexed from 0. Obj dest = gotoR.putArray("D"); // Set the destination dest.pushBackNumber(9); dest.pushBackName("Fit"); } doc.save((Utils.createExternalFile("bookmark_remote.pdf", mFileList).getAbsolutePath()), SDFDoc.SaveMode.LINEARIZED, null); mOutputListener.println("Done. Result saved in bookmark_remote.pdf"); } catch (Exception e) { mOutputListener.printError(e.getStackTrace()); } for (String file : mFileList) { addToFileList(file); } printFooter(outputListener); } static void PrintIndent(Bookmark item) throws PDFNetException { int ident = item.getIndent() - 1; for (int i = 0; i < ident; ++i) mOutputListener.print(" "); } // Prints out the outline tree to the standard output static void PrintOutlineTree(Bookmark item) throws PDFNetException { for (; item.isValid(); item = item.getNext()) { PrintIndent(item); mOutputListener.print((item.isOpen() ? "- " : "+ ") + item.getTitle() + " ACTION -> "); // Print Action Action action = item.getAction(); if (action.isValid()) { if (action.getType() == Action.e_GoTo) { Destination dest = action.getDest(); if (dest.isValid()) { Page page = dest.getPage(); mOutputListener.println("GoTo Page #" + page.getIndex()); } } else { mOutputListener.println("Not a 'GoTo' action"); } } else { mOutputListener.println("NULL"); } if (item.hasChildren()) // Recursively print children sub-trees { PrintOutlineTree(item.getFirstChild()); } } } } ``` {% endcode %} {% endtab %} {% tab title="Kotlin" %} {% code lineNumbers="true" %} ```kotlin //--------------------------------------------------------------------------------------- // Copyright (c) 2001-2019 by PDFTron Systems Inc. All Rights Reserved. // Consult legal.txt regarding legal and license information. //--------------------------------------------------------------------------------------- package com.pdftron.android.pdfnetsdksamples.samples import com.pdftron.android.pdfnetsdksamples.OutputListener import com.pdftron.android.pdfnetsdksamples.PDFNetSample import com.pdftron.android.pdfnetsdksamples.R import com.pdftron.android.pdfnetsdksamples.util.Utils import com.pdftron.common.PDFNetException import com.pdftron.pdf.* import com.pdftron.sdf.SDFDoc import java.util.* class BookmarkTest : PDFNetSample() { init { setTitle(R.string.sample_bookmarks_title) setDescription(R.string.sample_bookmarks_description) } override fun run(outputListener: OutputListener?) { super.run(outputListener) mOutputListener = outputListener mFileList.clear() printHeader(outputListener!!) // The following example illustrates how to create and edit the outline tree // using high-level Bookmark methods. try { PDFDoc(Utils.getAssetTempFile(PDFNetSample.INPUT_PATH + "numbered.pdf")!!.absolutePath).use { doc -> doc.initSecurityHandler() // Lets first create the root bookmark items. val red = Bookmark.create(doc, "Red") val green = Bookmark.create(doc, "Green") val blue = Bookmark.create(doc, "Blue") doc.addRootBookmark(red) doc.addRootBookmark(green) doc.addRootBookmark(blue) // You can also add new root bookmarks using Bookmark.AddNext("...") blue.addNext("foo") blue.addNext("bar") // We can now associate new bookmarks with page destinations: // The following example creates an 'explicit' destination (see // section '8.2.1 Destinations' in PDF Reference for more details) val red_dest = Destination.createFit(doc.pageIterator.next()) red.action = Action.createGoto(red_dest) // Create an explicit destination to the first green page in the document green.action = Action.createGoto( Destination.createFit(doc.getPage(10))) // The following example creates a 'named' destination (see // section '8.2.1 Destinations' in PDF Reference for more details) // Named destinations have certain advantages over explicit destinations. val key = byteArrayOf('b'.toByte(), 'l'.toByte(), 'u'.toByte(), 'e'.toByte(), '1'.toByte()) val blue_action = Action.createGoto(key, Destination.createFit(doc.getPage(19))) blue.action = blue_action // We can now add children Bookmarks val sub_red1 = red.addChild("Red - Page 1") sub_red1.action = Action.createGoto(Destination.createFit(doc.getPage(1))) val sub_red2 = red.addChild("Red - Page 2") sub_red2.action = Action.createGoto(Destination.createFit(doc.getPage(2))) val sub_red3 = red.addChild("Red - Page 3") sub_red3.action = Action.createGoto(Destination.createFit(doc.getPage(3))) val sub_red4 = sub_red3.addChild("Red - Page 4") sub_red4.action = Action.createGoto(Destination.createFit(doc.getPage(4))) val sub_red5 = sub_red3.addChild("Red - Page 5") sub_red5.action = Action.createGoto(Destination.createFit(doc.getPage(5))) val sub_red6 = sub_red3.addChild("Red - Page 6") sub_red6.action = Action.createGoto(Destination.createFit(doc.getPage(6))) // Example of how to find and delete a bookmark by title text. val foo = doc.firstBookmark.find("foo") if (foo.isValid) { foo.delete() } else { throw Exception("Foo is not Valid") } val bar = doc.firstBookmark.find("bar") if (bar.isValid) { bar.delete() } else { throw Exception("Bar is not Valid") } // Adding color to Bookmarks. Color and other formatting can help readers // get around more easily in large PDF documents. red.setColor(1.0, 0.0, 0.0) green.setColor(0.0, 1.0, 0.0) green.flags = 2 // set bold font blue.setColor(0.0, 0.0, 1.0) blue.flags = 3 // set bold and itallic doc.save(Utils.createExternalFile("bookmark.pdf", mFileList).absolutePath, SDFDoc.SaveMode.NO_FLAGS, null) mOutputListener!!.println("Done. Result saved in bookmark.pdf") } } catch (e: Exception) { mOutputListener!!.printError(e.stackTrace) } // The following example illustrates how to traverse the outline tree using // Bookmark navigation methods: Bookmark.GetNext(), Bookmark.GetPrev(), // Bookmark.GetFirstChild () and Bookmark.GetLastChild (). try { // Open the document that was saved in the previous code sample PDFDoc(Utils.createExternalFile("bookmark.pdf", mFileList).absolutePath).use { doc -> doc.initSecurityHandler() val root = doc.firstBookmark PrintOutlineTree(root) mOutputListener!!.println("Done.") } } catch (e: Exception) { mOutputListener!!.printError(e.stackTrace) } // The following example illustrates how to create a Bookmark to a page // in a remote document. A remote go-to action is similar to an ordinary // go-to action, but jumps to a destination in another PDF file instead // of the current file. See Section 8.5.3 'Remote Go-To Actions' in PDF // Reference Manual for details. try { // Open the document that was saved in the previous code sample PDFDoc(Utils.createExternalFile("bookmark.pdf", mFileList).absolutePath).use { doc -> doc.initSecurityHandler() // Create file specification (the file reffered to by the remote bookmark) val file_spec = doc.createIndirectDict() file_spec.putName("Type", "Filespec") file_spec.putString("F", "bookmark.pdf") val spec = FileSpec(file_spec) val goto_remote = Action.createGotoRemote(spec, 5, true) val remoteBookmark1 = Bookmark.create(doc, "REMOTE BOOKMARK 1") remoteBookmark1.action = goto_remote doc.addRootBookmark(remoteBookmark1) // Create another remote bootmark, but this time using the low-level SDF/Cos API. // Create a remote action val remoteBookmark2 = Bookmark.create(doc, "REMOTE BOOKMARK 2") doc.addRootBookmark(remoteBookmark2) val gotoR = remoteBookmark2.sdfObj.putDict("A") run { gotoR.putName("S", "GoToR") // Set action type gotoR.putBool("NewWindow", true) // Set the file specification gotoR.put("F", file_spec) // jump to the first page. Note that pages are indexed from 0. val dest = gotoR.putArray("D") // Set the destination dest.pushBackNumber(9.0) dest.pushBackName("Fit") } doc.save(Utils.createExternalFile("bookmark_remote.pdf", mFileList).absolutePath, SDFDoc.SaveMode.LINEARIZED, null) mOutputListener!!.println("Done. Result saved in bookmark_remote.pdf") } } catch (e: Exception) { mOutputListener!!.printError(e.stackTrace) } for (file in mFileList) { addToFileList(file) } printFooter(outputListener) } companion object { private var mOutputListener: OutputListener? = null private val mFileList = ArrayList() @Throws(PDFNetException::class) internal fun PrintIndent(item: Bookmark) { val ident = item.indent - 1 for (i in 0 until ident) mOutputListener!!.print(" ") } // Prints out the outline tree to the standard output @Throws(PDFNetException::class) internal fun PrintOutlineTree(item: Bookmark) { var item = item while (item.isValid) { PrintIndent(item) mOutputListener!!.print((if (item.isOpen) "- " else "+ ") + item.title + " ACTION -> ") // Print Action val action = item.action if (action.isValid) { if (action.type == Action.e_GoTo) { val dest = action.dest if (dest.isValid) { val page = dest.page mOutputListener!!.println("GoTo Page #" + page.index) } } else { mOutputListener!!.println("Not a 'GoTo' action") } } else { mOutputListener!!.println("NULL") } if (item.hasChildren()) // Recursively print children sub-trees { PrintOutlineTree(item.firstChild) } item = item.next } } } } ``` {% endcode %} {% endtab %} {% endtabs %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.apryse.com/android/get-started/samples/bookmarktest.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.