Aspose::Cells::Rendering::PdfBookmarkEntry class
Contents
[
Hide
]PdfBookmarkEntry class
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.
class PdfBookmarkEntry
Methods
| Method | Description |
|---|---|
| GetDestination() | The cell to which the bookmark link. |
| GetDestinationName() | Gets or sets name of destination. |
| GetText() | Title of a bookmark. |
| IsCollapse() | When this property is true, the bookmarkentry will collapse, otherwise it will expand. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| IsOpen() | When this property is true, the bookmarkentry will expand, otherwise it will collapse. |
| explicit operator bool() const | operator bool() |
| operator=(const PdfBookmarkEntry& src) | operator= |
| PdfBookmarkEntry() | Default constructor. |
| PdfBookmarkEntry(PdfBookmarkEntry_Impl* impl) | Constructs from an implementation object. |
| PdfBookmarkEntry(const PdfBookmarkEntry& src) | Copy constructor. |
| SetDestination(const Cell& value) | The cell to which the bookmark link. |
| SetDestinationName(const U16String& value) | Gets or sets name of destination. |
| SetDestinationName(const char16_t* value) | Gets or sets name of destination. |
| SetIsCollapse(bool value) | When this property is true, the bookmarkentry will collapse, otherwise it will expand. |
| SetIsOpen(bool value) | When this property is true, the bookmarkentry will expand, otherwise it will collapse. |
| SetText(const U16String& value) | Title of a bookmark. |
| SetText(const char16_t* value) | Title of a bookmark. |
| ~PdfBookmarkEntry() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
Examples
Aspose::Cells::Startup();
Workbook workbook;
workbook.GetWorksheets().Add();
workbook.GetWorksheets().Add();
Cell cellInPage1 = workbook.GetWorksheets().Get(0).GetCells().Get(u"A1");
Cell cellInPage2 = workbook.GetWorksheets().Get(1).GetCells().Get(u"A1");
Cell cellInPage3 = workbook.GetWorksheets().Get(2).GetCells().Get(u"A1");
cellInPage1.PutValue(u"page1");
cellInPage2.PutValue(u"page2");
cellInPage3.PutValue(u"page3");
PdfBookmarkEntry pbeRoot;
pbeRoot.SetText(u"root"); // if pbeRoot.Text = null, all children of pbeRoot will be inserted on the top level in the bookmark.
pbeRoot.SetDestination(cellInPage1);
pbeRoot.SetIsOpen(false);
PdfBookmarkEntry subPbe1;
subPbe1.SetText(u"section1");
subPbe1.SetDestination(cellInPage2);
PdfBookmarkEntry subPbe2;
subPbe2.SetText(u"section2");
subPbe2.SetDestination(cellInPage3);
PdfSaveOptions saveOptions;
saveOptions.SetBookmark(pbeRoot);
workbook.Save(u"output_bookmark.pdf", saveOptions);
Aspose::Cells::Cleanup();
See Also
- Namespace Aspose::Cells::Rendering
- Library Aspose.Cells for C++