Online Edit
Quick Start
Run Spire.Cloud Online Editor in Your Web Application
Getting Started with Spire.Cloud Online Editor
Spire.Cloud Word Editor
How to Add a Watermark to Word
How to Insert and Customize Footnotes
How to Insert a WordArt
How to Insert a Picture in Word
How to Insert a Link in Word
How to Add Comments in Word
How to Add a Column to Word
Spire.Cloud Excel Editor
How to Create a Table in Excel
How to Insert a Chart in Excel
Web API
.NET
Spire.Cloud.Word
Replace Text in Word Using Spire.Cloud.Word
Add, Remove or Edit Paragraphs in Word Using Spire.Cloud.Word
Convert Word to PDF or XPS Using Spire.Cloud.Word
Encrypt Word Documents Using Spire.Cloud.Word
Add Text and Image Watermarks to Word using Spire.Cloud.Word
Remove Watermarks from Word using Spire.Cloud.Word
Set Background Color and Image for Word using Spire.Cloud
Spire.Cloud.Excel
Freeze or Unfreeze Excel Columns and Rows Using Spire.Cloud.Excel
Add or Delete Excel Comments Using Spire.Cloud.Excel
Convert Excel to PDF or XPS Using Spire.Cloud.Excel
Set or Remove Excel Document Properties Using Spire.Cloud.Excel
Encrypt or Decrypt Excel Documents Using Spire.Cloud.Excel
Merge and Unmerge Excel Cells using Spire.Cloud.Excel
Protect or Unprotect Excel Worksheet using Spire.Cloud.Excel
Replace Text in Excel in C# using Spire.Cloud.Excel
Spire.Cloud.PowerPoint
Add a Table to PowerPoint Using Spire.Cloud.PowerPoint
Add an Image to PowerPoint Using Spire.Cloud.PowerPoint
Set or Remove PowerPoint Document Properties Using Spire.Cloud.PowerPoint
Convert PowerPoint to PDF or Images Using Spire.Cloud.PowerPoint
Add Background Color or Image to Slides Using Spire.Cloud.PowerPoint
Add, Update and Remove Speaker Notes in PowerPoint using Spire.Cloud.PowerPoint
Replace Text in PowerPoint using Spire.Cloud.PowerPoint
Spire.Cloud.PDF
Merge or Split PDF Documents Using Spire.Cloud.PDF
Add and Delete PDF Document Properties using Spire.Cloud.PDF
Add or Extract Images in PDF Using Spire.Cloud.PDF
Install Spire.Cloud Web API via NuGet
How to Use Spire.Cloud Web API in .NET
Java
Spire.Cloud.Word
Create a Blank Word Document using Spire.Cloud.Word
Merge Word documents in Java using Spire.Cloud.Word
Encrypt Word Documents Using Spire.Cloud.Word
Add Table to Word Document using Spire.Cloud.Word
Remove Watermark in Word Document using Spire.Cloud.Word
Replace Text in a Word document Using Spire.Cloud.Word
Convert Word to HTML in Java using Spire.Cloud.Word
Add Digital Signature to Word using Spire.Cloud.Word
Add and Delete Shapes in Word Using Spire.Cloud.Word
Add and Delete Images in Word Using Spire.Cloud.Word
Add, Get and Delete Custom Document Properties in Word using Spire.Cloud.Word
Add/Replace/Delete Paragraphs in Word Document Using Spire.Cloud.Word
Spire.Cloud.Excel
Freeze or Unfreeze Excel Rows and Columns using Spire.Cloud.Excel
Merge Excel Cells and Set Cell Format using Spire.Cloud.Excel
Spire.Cloud.Excel Encrypt/Decrypt Excel Documents
Rename Excel Worksheet Using Spire.Cloud.Excel
Add or Delete Comments in Excel Worksheets
Set and Delete Excel Document Properties Using Spire.Cloud.Excel
Spire.Cloud.PowerPoint
Add Image to a PowerPoint Document using Spire.Cloud.PowerPoint
Create a table in PowerPoint using Spire.Cloud.PowerPoint
Convert PPT(X) to PDF using Spire.Cloud.PowerPoint
Convert PPT(X) to PNG using Spire.Cloud.PowerPoint
Set and Delete PowerPoint Document Properties Using Spire.Cloud.PowerPoint
Replace Text in PowerPoint in Java using Spire.Cloud.PowerPoint
Spire.Cloud.PDF
Add/ Delete PDF Page Using Spire.Cloud.PDF
Convert PDF to Image using Spire.Cloud.PDF
Draw Shapes in PDF Using Spire.Cloud.PDF
Convert PDF to Word Document Using Spire.Cloud.PDF
Add, Update and Delete PDF Document Properties using Spire.Cloud.PDF
Add an Image to PDF Document Using Spire.Cloud.PDF
Merge and Split PDF Documents Using Spire.Cloud.PDF
Add Lists to PDF using Spire.Cloud.PDF
Add, Update, Get and Delete Bookmarks in PDF
Install Spire.Cloud Web API from Maven Repository
How to Use Spire.Cloud Web API in Java

Add, Update, Get and Delete Bookmarks in PDF

Spire.Cloud.PDF offers the pdfBookmarkApi interface to manipulate bookmarks in PDF documents. In this tutorial, I’ll show you how to add a bookmark to a PDF document and then how to update, get and delete the bookmark using Java codes.

Add a bookmark to PDF

import spire.cloud.pdf.sdk.*;
import spire.cloud.pdf.sdk.api.PdfBookmarksApi;
import spire.cloud.pdf.sdk.model.*;

public class AddBookmark {
        //Create a configuration object based on your App ID and App Key
        static String appId = "App ID";
        static String appKey = "App Key";
        static String baseUrl = "https://api.cloudxdocs.com";
        static Configuration PdfConfiguration = new Configuration(appId, appKey, baseUrl);
       //Create a PdfBookmarkApi instance
        static PdfBookmarksApi pdfBookmarkApi = new PdfBookmarksApi(PdfConfiguration);

        public static void main (String[]args) throws ApiException {
            //load a PDF sample
            String name = "Sample.pdf";
            //Specify the folder storing the sample, and it’s null if nothing
            String folder = "input";
            //Specify the password used to open the sample, and it's null if nothing
            String password = null;
            //Use the 2G storage provided by E-iceblue Cloud, and it’s null by default
            String storage = null;
            //Save the resulting document
            String outPath = "AddBookmark.pdf";

            //Create a bookmark and set its title, color, font and so on
            Bookmark bookmark = new Bookmark();
            bookmark.setTitle("NewBookmark");
            Color color = new Color();
            color.A(0);
            color.R(255);
            color.G(0);
            color.B(0);
            bookmark.setColor(color);
            bookmark.setPageNumber(2);//Specify the page which needs to add the bookmark
            bookmark.setBold(true);
            bookmark.setItalic(true);
            bookmark.setPageDisplay(Bookmark.PageDisplayEnum.XYZ);
            bookmark.setPageDisplayLeft(10f);
            bookmark.setPageDisplayTop(20f);
            String bookmarkPath = "1"; //Specify the bookmark level

            //Call the addBookmark method to add a bookmark to a PDF document
            pdfBookmarkApi.addBookmark(name, outPath, bookmarkPath, bookmark, folder, storage, password);
        }
    }

Output

Add, Update, Get and Delete Bookmarks in PDF

Update the existing bookmark in PDF

import spire.cloud.pdf.sdk.*;
import spire.cloud.pdf.sdk.api.PdfBookmarksApi;
import spire.cloud.pdf.sdk.model.*;

public class UpdateBookmark {
    //Create a configuration object based on your App ID and App Key
    static String appId = "App ID";
    static String appKey = "App Key";
    static String baseUrl = "https://api.cloudxdocs.com";
    static Configuration PdfConfiguration = new Configuration(appId, appKey, baseUrl);
    //Create a PdfBookmarkApi instance
    static PdfBookmarksApi pdfBookmarkApi = new PdfBookmarksApi(PdfConfiguration);

    public static void main(String[] args) throws ApiException {
        //load a PDF sample
        String name = "AddBookmark.pdf";
        //Specify the folder storing the sample, and it’s null if nothing
        String folder = "input";
        //Use the 2G storage provided by E-iceblue Cloud, and it’s null by default
        String storage = null;
        //Specify the password used to open the sample, and it's null if nothing
        String password = null;
        //Save the resulting document
        String outPath = "UpdateBookmark.pdf";
        //Specify the bookmark level
        String bookmarkPath = "1";

        //Instantiate a Bookmark object, and set the content and format of the new bookmark
        Bookmark bookmark = new Bookmark();
        bookmark.title("updateBookmark");
        Color color = new Color();
        color.A(0);
        color.R(0);
        color.G(0);
        color.B(255);
        bookmark.setColor(color);
        bookmark.pageNumber(1);
        bookmark.bold(false);
        bookmark.italic(false);
        bookmark.pageDisplay(Bookmark.PageDisplayEnum.XYZ);
        bookmark.pageDisplayLeft(10f);
        bookmark.pageDisplayTop(20f);

        //Call the updateBookmark method to replace the existing bookmark with a new one
        pdfBookmarkApi.updateBookmark(name, outPath, bookmarkPath, bookmark, folder, storage, password);
    }
}

Output

Add, Update, Get and Delete Bookmarks in PDF

Get information of bookmarks in PDF

import spire.cloud.pdf.sdk.*;
import spire.cloud.pdf.sdk.api.PdfBookmarksApi;
import spire.cloud.pdf.sdk.model.*;
public class GetBookmark {
    //Create a configuration object based on your App ID and App Key
    static String appId = "App ID";
    static String appKey = "App Key";
    static String baseUrl = "https://api.cloudxdocs.com";
    static Configuration PdfConfiguration = new Configuration(appId, appKey, baseUrl);
    //Create a PdfBookmarkApi instance
    static PdfBookmarksApi pdfBookmarkApi = new PdfBookmarksApi(PdfConfiguration);

    public static void main(String[] args) throws ApiException {
        //load a PDF sample including bookmarks
        String name = "UpdateBookmark.pdf";
        //Specify the folder storing the sample, and it’s null if nothing
        String folder = null;
        //Specify the bookmark level if you want to get information of a specified bookmark
        //String bookmarkPath = "1-1";
        //Use the 2G storage provided by E-iceblue Cloud, and it’s null by default
        String storage = null;
        //Specify the password used to open the sample, and it's null if nothing
        String password = null;

        //Call the pdfBookmarkApi method to get information of all bookmarks including parent bookmarks and child bookmarks
        Bookmarks response = pdfBookmarkApi.getBookmarksInfo(name, folder, storage, password);
        System.out.println(response);

        /*//Call the pdfBookmarkApi method to get information of a specified bookmark
        Bookmark response =pdfBookmarkApi.getBookmarkInfo(name, bookmarkPath, folder, storage, password);*/
    }
}

Output

Add, Update, Get and Delete Bookmarks in PDF

Delete bookmarks in PDF

import spire.cloud.pdf.sdk.*;
import spire.cloud.pdf.sdk.api.PdfBookmarksApi;

public class DeleteBookmark {
    //Create a configuration object based on your App ID and App Key
    static String appId = "App ID";
    static String appKey = "App Key";
    static String baseUrl = "https://api.cloudxdocs.com";
    static Configuration PdfConfiguration = new Configuration(appId, appKey, baseUrl);
    //Create a PdfBookmarkApi instance
    static PdfBookmarksApi pdfBookmarkApi = new PdfBookmarksApi(PdfConfiguration);

    public static void main(String[] args) throws ApiException {
        //load a PDF sample
        String name = "UpdateBookmark.pdf";
        //Specify the folder storing the sample, and it’s null if nothing
        String folder = "input";
        //Use the 2G storage provided by E-iceblue Cloud, and it’s null by default
        String storage = null;
        //Specify the password of the sample, and it's null if nothing
        String password = null;
        //Save the resulting document
        String outPath = "DeleteBookmark.pdf";
        //Specify the bookmark level if you want to delete specified child bookmarks
        //String bookmarkPath = "2-3";

        //Call the deleteBookmarks method to delete all bookmarks
        pdfBookmarkApi.deleteBookmarks(name, outPath, folder, storage, password);

        /*//Call the deleteBookmark method to delete specified child bookmarks
        pdfBookmarkApi.deleteBookmark(name, outPath, bookmarkPath, folder, storage, password);*/
    }
}