How to read bookmark titles?

I am working with a single PDF containing multiple documents. Each document has a bookmark. I need to read the bookmark names for a reconciliation application that I am building. The code below is not working for me.


PdfReader reader = new PdfReader("C:\\Work\\Input.pdf");
ListHashMapString,Object>> bookmarks = SimpleBookmark.getBookmark(reader);
for(int i = 0; i  bookmarks.size(); i++){
    HashMapString, Object> bm = bookmarks.get(i);
    String title = ((String)bm.get("Title"));

I am trying to place the bookmark name in the title string.

Posted on StackOverflow on Feb 20, 2015 by jcalder

You are not taking into account that bookmarks are stored in a tree structure with branches and leaves (in the PDF specification, it's called the outline tree).

Your code works for the top-level, but if you want to see all the titles, you need to use a recursive method that also looks at the "Kids".

Take a look at the FetchBookmarkTitles example:

public void inspectPdf(String src) throws IOException {
    PdfDocument pdfDoc = new PdfDocument(new PdfReader(new FileInputStream(src)));
    PdfOutline outlines = pdfDoc.getOutlines(false);
    StringBuffer stringBuffer = new StringBuffer();
    showTitle(outlines, stringBuffer);

public void showTitle(HashMap bm) {
    List> kids =
    if (kids != null) {
        for (int i = 0; i 

The showTitle() method is recursive. It calls itself if an examined bookmark entry has kids. With this code snippet, you can walk through all the branches and leaves of the outline tree.

Click this link if you want to see how to answer this question in iText 5.

Ready to use iText?

Try our iText 7 Library and add-ons FREE for 30 days. Test your proof of concept, and see if our solution is right for you.

Get my FREE trial

Still have questions? 

We're happy to answer your questions. Reach out to us and we'll get back to you shortly.

Contact us
Stay updated

Join 11,000+ subscribers and become an iText PDF expert by staying up to date with our new products, updates, tips, technical solutions and happenings.

Subscribe Now