PdfBookmarkEditor Class
Represents a class to work with PDF file's bookmarks including create, modify, export, import and delete.
Inheritance Hierarchy

Namespace: Aspose.Pdf.Facades
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 19.10
Syntax
public sealed class PdfBookmarkEditor : SaveableFacade

The PdfBookmarkEditor type exposes the following members.

Constructors
  NameDescription
Public methodPdfBookmarkEditor
Initializes new PdfBookmarkEditor object.
Public methodPdfBookmarkEditor(Document)
Initializes new PdfBookmarkEditor object on base of the document.
Properties
  NameDescription
Public propertyDocument
Gets the document facade is working on.
(Inherited from Facade.)
Methods
  NameDescription
Public methodBindPdf(Stream)
Initializes the facade.
(Inherited from Facade.)
Public methodBindPdf(String)
Initializes the facade.
(Inherited from Facade.)
Public methodBindPdf(Document)
Initializes the facade.
(Inherited from Facade.)
Public methodClose
Disposes Aspose.Pdf.Document bound with a facade.
(Inherited from Facade.)
Public methodCode exampleCreateBookmarkOfPage(String, Int32)
Creates bookmark for the specified page.
Public methodCode exampleCreateBookmarkOfPage(String, Int32)
Creates bookmarks for the specified pages.
Public methodCode exampleCreateBookmarks
Creates bookmarks for all pages.
Public methodCode exampleCreateBookmarks(Bookmark)
Creates the specified bookmark in the document. The method can be used for forming nested bookmarks hierarchy.
Public methodCode exampleCreateBookmarks(Color, Boolean, Boolean)
Create bookmarks for all pages with specified color and style (bold, italic).
Public methodCode exampleDeleteBookmarks
Deletes all bookmarks of the PDF document.
Public methodCode exampleDeleteBookmarks(String)
Deletes the bookmark of the PDF document.
Public methodDispose
Disposes the facade.
(Inherited from Facade.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodStatic memberCode exampleExportBookmarksToHtml
Exports bookmarks to HTML file.
Public methodExportBookmarksToXML(Stream)
Exports bookmarks to XML stream.
Public methodCode exampleExportBookmarksToXML(String)
Exports bookmarks to XML file.
Public methodCode exampleExtractBookmarks
Extracts bookmarks of all levels from the document.
Public methodExtractBookmarks(Boolean)
Extracts bookmarks of all levels from the document.
Public methodCode exampleExtractBookmarks(String)
Extracts the bookmarks with the specified title.
Public methodCode exampleExtractBookmarks(Bookmark)
Extracts the children of a bookmark with a title like in specified bookamrk.
Public methodCode exampleExtractBookmarksToHTML Obsolete.
Exports bookmarks to HTML file.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the type of the current instance.
(Inherited from Object.)
Public methodImportBookmarksWithXML(Stream)
Imports bookmarks to the document from XML file.
Public methodCode exampleImportBookmarksWithXML(String)
Imports bookmarks to the document from XML file.
Public methodCode exampleModifyBookmarks
Modifys bookmark title according to the specified bookmark title.
Public methodSave(Stream)
Saves the PDF document to the specified stream.
(Inherited from SaveableFacade.)
Public methodSave(String)
Saves the PDF document to the specified file.
(Inherited from SaveableFacade.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
See Also