asposecells.api

Class PdfBookmarkEntry

PdfBookmarkEntry is an entry in pdf bookmark. if Text property of current instance is null or "", current instance will be hidden and children will be inserted on current level.

Example:

import jpype
import asposecells
jpype.startJVM()
from asposecells.api import *
from java.util import ArrayList

workbook = Workbook()
workbook.getWorksheets().add()
workbook.getWorksheets().add()
cellInPage1 = workbook.getWorksheets().get(0).getCells().get("A1")
cellInPage2 = workbook.getWorksheets().get(1).getCells().get("A1")
cellInPage3 = workbook.getWorksheets().get(2).getCells().get("A1")
cellInPage1.putValue("page1")
cellInPage2.putValue("page2")
cellInPage3.putValue("page3")

pbeRoot = PdfBookmarkEntry()
pbeRoot.setText("root")
pbeRoot.setDestination(cellInPage1)
pbeRoot.setSubEntry(ArrayList())
pbeRoot.setOpen(False)

subPbe1 = PdfBookmarkEntry()
subPbe1.setText("section1")
subPbe1.setDestination(cellInPage2)

subPbe2 = PdfBookmarkEntry()
subPbe2.setText("section2")
subPbe2.setDestination(cellInPage3)

pbeRoot.getSubEntry().add(subPbe1)
pbeRoot.getSubEntry().add(subPbe2)

opts = PdfSaveOptions()
opts.setBookmark(pbeRoot)
workbook.save("Test.pdf", opts)

Constructor Summary
 
Property Getters/Setters Summary
methodgetDestination()
method
           The cell to which the bookmark link.
methodgetDestinationName()
method
           Gets or sets name of destination.
methodisCollapse()
method
           When this property is true, the bookmarkentry will collapse, otherwise it will expand.
methodisOpen()
method
setOpen(value)
           When this property is true, the bookmarkentry will expand, otherwise it will collapse.
methodgetSubEntry()
method
           SubEntry of a bookmark.
methodgetText()
method
setText(value)
           Title of a bookmark.
 

    • Constructor Detail

      • PdfBookmarkEntry

        PdfBookmarkEntry()
    • Property Getters/Setters Detail

      • getText/setText : String 

        String getText() / setText(value)
        
        Title of a bookmark.
      • getDestination/setDestination : Cell 

        Cell getDestination() / setDestination(value)
        
        The cell to which the bookmark link.
      • getDestinationName/setDestinationName : String 

        String getDestinationName() / setDestinationName(value)
        
        Gets or sets name of destination. If desitnation name is set, the desitnation will be defined as a named destination with this name.
      • getSubEntry/setSubEntry : ArrayList 

        ArrayList getSubEntry() / setSubEntry(value)
        
        SubEntry of a bookmark.
      • isOpen/setOpen : boolean 

        boolean isOpen() / setOpen(value)
        
        When this property is true, the bookmarkentry will expand, otherwise it will collapse.
      • isCollapse/setCollapse : boolean 

        boolean isCollapse() / setCollapse(value)
        
        When this property is true, the bookmarkentry will collapse, otherwise it will expand.