Click or drag to resize

Bookmark Class

Gets the first bookmark
Adds/links the specified Bookmark to the root level of document’s outline tree.
A %PDF document may optionally display a document outline on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of Bookmarks (sometimes called outline items), which serve as a 'visual table of contents' to display the document’s structure to the user. Each Bookmark has a title that appears on screen, and an Action that specifies what happens when a user clicks on the Bookmark. The typical action for a user-created Bookmark is to move to another location in the current document, although any action (see PDF::Action) can be specified. Bookmark is a utility class used to simplify work with %PDF bookmarks (or outlines; see section 8.2.2 'Document Outline' in %PDF Reference Manual for more details).
Inheritance Hierarchy
SystemObject
  pdftron.PDFBookmark

Namespace:  pdftron.PDF
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
public sealed class Bookmark : IClosable

Return Value

Type: 
the first Bookmark from the document’s outline tree. If the Bookmark tree is empty the underlying SDF/Cos Object is null and returned Bookmark is not valid (i.e. Bookmark::IsValid() returns false).

The Bookmark type exposes the following members.

Constructors
  NameDescription
Public methodBookmark
A constructor. Creates a bookmark from specified SDF::Obj
Top
Methods
  NameDescription
Public methodAddChild(String)
Adds a new Bookmark as the new last child of this Bookmark.
Public methodAddChild(Bookmark)
Adds the specified Bookmark as the new last child of this Bookmark.
Public methodAddNext(String)
Adds a new Bookmark to the tree containing this Bookmark, as the new right sibling.
Public methodAddNext(Bookmark)
Adds the specified Bookmark as the new right sibling to this Bookmark, adjusting the tree containing this Bookmark appropriately.
Public methodAddPrev(String)
Adds a new Bookmark to the tree containing this Bookmark, as the new left sibling.
Public methodAddPrev(Bookmark)
Adds the specified Bookmark as the new left sibling to this Bookmark, adjusting the tree containing this Bookmark appropriately.
Public methodClose
Public methodStatic memberCreate
Creates a new valid Bookmark with given title in the specified document.
Public methodDelete
Removes the Bookmark's subtree from the bookmark tree containing it.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFind
Gets the Bookmark specified by the given title string.
Public methodGetAction
Gets the Bookmark's action.
Public methodCode exampleGetColor
Gets the Bookmark's RGB color value.
Public methodGetFirstChild
Returns the Bookmark's first child.
Public methodGetFlags
Gets the Bookmark's flags.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIndent
Gets the indentation level of the Bookmark in its containing tree.
Public methodGetLastChild
Returns the Bookmark's last child.
Public methodGetNext
Returns the Bookmark's next (right) sibling.
Public methodGetOpenCount
Gets the number of opened bookmarks in this subtree.
Public methodGetParent
Returns the Bookmark's parent Bookmark.
Public methodGetPrev
Returns the Bookmark's previous (left) sibling.
Public methodGetSDFObj
Returns the underlying SDF/Cos object.
Public methodGetTitle
Gets the Bookmark's title string.
Public methodGetTitleObj
Gets the Bookmark's title string object.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasChildren
Indicates whether the Bookmark has children.
Public methodIsOpen
Indicates whether the Bookmark is open.
Public methodIsValid
Indicates whether the Bookmark is valid (non-null).
Public methodRemoveAction
Removes the Bookmark’s action.
Public methodSet
Sets value to the specified Bookmark
Public methodSetAction
Sets the Bookmark’s action.
Public methodSetColor
Sets the color.
Public methodSetFlags
Sets the Bookmark's flags.
Public methodSetOpen
Opens or closes the Bookmark.
Public methodSetTitle
Sets the Bookmark’s title string.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnlink
Unlinks this Bookmark from the bookmark tree that contains it, and adjusts the tree appropriately.
Top
Remarks
parameter 'root_bookmark' must not be linked (must not be belong) to a bookmark tree.
See Also