HTML JPG PDF XML DOCX
Product Family
PDF

Add Bookmarks to PDF in Java SDK

Add a Bookmark to a PDF Document using server-side Java API.

Get Started
 

Aspose.PDF Cloud SDK for Java Aspose.PDF Cloud SDK for Java

Overview

GitHub Learn Buy
NET PHP PYTHON GO NODEJS

How to create Bookmark via Cloud Java SDK

In order to create a Bookmark via Cloud Java SDK , we’ll use Aspose.PDF Cloud Java SDK This Cloud SDK allows you to easily build cloud-based PDF creator, editor & converter apps in Java language for various cloud platforms. Open Repository package manager, search for Aspose.PDF Cloud and install. You may also use the following command from the Package Manager Console for install it using Maven.

Add Aspose Cloud repository to your application pom.xml

Add Aspose Cloud repository


    <repositories>
        <repository>
            <id>aspose-cloud</id>
            <name>Aspose Cloud Repository</name>
            <url>https://releases.aspose.cloud/java/repo/</url>
        </repository>
    </repositories>

To install the API client library to your local Maven repository, simply execute:

Installation from Github


    mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

Deploy Maven repository


    mvn clean deploy

Steps to create a Bookmark via Java SDK

Aspose.PDF Cloud developers can easily load & create bookmark in PDF in just a few lines of code.

  1. Create a new Configuration object with your Application Secret and Key
  2. Create an object to connect to the Cloud API
  3. Upload your document file
  4. Set desired property using PostBookmark
  5. Checks the response and logs the result.
  6. Downloads the updated file for local use.
 

This sample code shows creating a Bookmark in PDF documents


    package com.aspose.asposecloudpdfusecases.bookmarks;

    import java.io.File;
    import java.nio.file.Path;
    import java.nio.file.StandardCopyOption;
    import java.util.ArrayList;
    import com.aspose.asposecloudpdf.api.PdfApi;
    import com.aspose.asposecloudpdf.model.Bookmark;
    import com.aspose.asposecloudpdf.model.BookmarksResponse;
    import com.aspose.asposecloudpdf.model.Color;

    public class BookmarkAdd{
        public static void Create() {
            String REMOTE_FOLDER   = "Your_Temp_Pdf_Cloud";
            String LOCAL_FOLDER    = "c:\\Samples";
            String PDF_DOCUMENT    = "sample.pdf";
            String PDF_OUTPUT      = "bookmarks_add_output.pdf";
            String BOOKMARK_TITLE = "NEW Bookmark Title XYZ";
            String BOOKMARK_PATH  = "/1";

            try {
                PdfApi pdfApi = new PdfApi(API_KEY, API_SECRET);

                // upload local PDF file to remote storage
                File file = new File(Path.of(LOCAL_FOLDER, PDF_DOCUMENT).toString());
                pdfApi.uploadFile(Path.of(REMOTE_FOLDER , PDF_DOCUMENT).toString(), file, null);
                System.out.println(String.format("File '%s' successfully uploaded!", Path.of(LOCAL_FOLDER, PDF_DOCUMENT).toString()));

                Bookmark bookmark = new Bookmark();
                bookmark.setAction("GoTo");
                bookmark.setBold(true);
                bookmark.setItalic(false);
                bookmark.setTitle(BOOKMARK_TITLE);
                bookmark.setPageDisplay("XYZ");
                bookmark.setPageDisplayBottom(10);
                bookmark.setPageDisplayLeft(10);
                bookmark.setPageDisplayRight(10);
                bookmark.setPageDisplayTop(10);
                bookmark.setPageDisplayZoom(2);
                bookmark.setPageNumber(1);
                bookmark.setColor(new Color().A(255).G(255));

                ArrayList<Bookmark> bookmarks = new ArrayList<Bookmark>();
                bookmarks.add(bookmark);

                BookmarksResponse response = pdfApi.postBookmark(PDF_DOCUMENT, BOOKMARK_PATH, bookmarks, REMOTE_FOLDER, null, null);
                if (response.getCode() != 200)
                    System.err.println("Error: unexpected error when adding bookmarks! '" + response.getStatus() + "'");
                else{
                    // download changed PDF file from remote folder...
                    File f = pdfApi.downloadFile(Path.of(REMOTE_FOLDER , PDF_DOCUMENT).toString(), null, null);
                    java.nio.file.Files.copy(Path.of(f.getPath()), Path.of(LOCAL_FOLDER, PDF_OUTPUT), StandardCopyOption.REPLACE_EXISTING);
                    System.out.println(String.format("File '%s' successfully dowloaded!", Path.of(LOCAL_FOLDER, PDF_OUTPUT).toString()));                
                    System.out.println("Successfully added bookmark in document ! '" + PDF_OUTPUT + "'");
                }
            }
            catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
 

Work with the bookmarks in PDF via Java SDK

Adding bookmarks to a PDF significantly improves document usability by enhancing navigation, organization, and accessibility. It is essential for large documents, ensuring users can efficiently find and access relevant content. Add the Bookmarks into PDF documents with Aspose.PDF Cloud Java SDK.

With our Java SDK you can

  • Add PDF document’s header & footer in text or image format.
  • Add tables & text or image stamps to PDF documents.
  • Append multiple PDF documents to an existing file.
  • Work with PDF attachments, annotations, & form fields.
  • Apply encryption or decryption to PDF documents & set a password.
  • Delete all stamps & tables from a page or entire PDF document.
  • Delete a specific stamp or table from the PDF document by its ID.
  • Replace single or multiple instances of text on a PDF page or from the entire document.
  • Extensive support for converting PDF documents to various other file formats.
  • Extract various elements of PDF files & make PDF documents optimized.
  • You can try out our free App to add the bookmarks into PDF files online and test the functionality.

    •