com.aspose.cells
Class PdfBookmarkEntry

java.lang.Object
    extended by com.aspose.cells.PdfBookmarkEntry

public class PdfBookmarkEntry 
extends java.lang.Object

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:

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

PdfBookmarkEntry pbeRoot = new PdfBookmarkEntry();
pbeRoot.setText("root");
pbeRoot.setDestination(cellInPage1);
pbeRoot.setSubEntry(new ArrayList());
pbeRoot.setOpen(false);

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

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

m$ArrayList.add(pbeRoot.getSubEntry(), subPbe1);
m$ArrayList.add(pbeRoot.getSubEntry(), subPbe2);

workbook.getSaveOptions().setPdfBookmark(pbeRoot);
workbook.save("c:\\Test.pdf");

Constructor Summary
PdfBookmarkEntry()
          
 
Property Getters/Setters Summary
CellgetDestination()
voidsetDestination(Cell value)
           The cell to which the bookmark link.
booleanisCollapse()
voidsetCollapse(boolean value)
           When this property is true, the bookmarkentry will collapse, otherwise it will expand.
booleanisOpen()
voidsetOpen(boolean value)
           When this property is true, the bookmarkentry will expand, otherwise it will collapse.
java.util.ArrayListgetSubEntry()
voidsetSubEntry(java.util.ArrayList value)
           SubEntry of a bookmark.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Title of a bookmark.
 

Constructor Detail

PdfBookmarkEntry

public PdfBookmarkEntry()

Property Getters/Setters Detail

getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Title of a bookmark.

getDestination/setDestination

public Cell getDestination() / public void setDestination(Cell value)
The cell to which the bookmark link.

getSubEntry/setSubEntry

public java.util.ArrayList getSubEntry() / public void setSubEntry(java.util.ArrayList value)
SubEntry of a bookmark.

isOpen/setOpen

public boolean isOpen() / public void setOpen(boolean value)
When this property is true, the bookmarkentry will expand, otherwise it will collapse.

isCollapse/setCollapse

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

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.