How to read bookmark titles?

I need to read the bookmark names for a reconciliation application that I am building.

24th October 2015

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 filename) throws IOException, DocumentException {
    PdfReader reader = new PdfReader(filename);
    List> bookmarks = SimpleBookmark.getBookmark(reader);
    for (int i = 0; i  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.


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