Bookmark Class Documentation

classBookmark : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

A bookmark on a page of a PDF document.

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 Action) can be specified.

Referenced by

BookmarkDocument

Constructor & Destructor Documentation

Bookmark

Bookmark(Bookmarkrhs, InternalConstructsignifier)

Parameters

rhs: Bookmark
signifier: InternalConstruct

~Bookmark

~Bookmark()

Property Documentation

Action

ActionAction[get, set]

Color

ColorColor[get, set]

Count

intCount[get]

FirstChild

BookmarkFirstChild[get]

Flags

BookmarkFlagsFlags[get, set]

Indent

intIndent[get]

LastChild

BookmarkLastChild[get]

Next

BookmarkNext[get]

Open

boolOpen[get, set]

PDFDict

PDFDictPDFDict[get]

Parent

BookmarkParent[get]

Previous

BookmarkPrevious[get]

Title

stringTitle[get, set]

ViewDestination

ViewDestinationViewDestination[get]

Member Function Documentation

AddChild

voidAddChild(Bookmarkchild)

Parameters

child: Bookmark

the bookmark being added.

Returns:

void

Add an existing bookmark to be the child bookmark of a parent.

AddNextSibling

voidAddNextSibling(BookmarkNewRightSibling)

Parameters

NewRightSibling: Bookmark

The bookmark to become the new right sibling.

Returns:

void

Add a bookmark to a tree as the next (right) sibling.

AddPreviousSibling

voidAddPreviousSibling(BookmarkNewLeftSibling)

Parameters

NewLeftSibling: Bookmark

The bookmark to become the new left sibling.

Returns:

void

Add a bookmark to a tree as the previous (left) sibling.

AddSubtree

voidAddSubtree(Bookmarksubtree, stringtitle)

Parameters

subtree: Bookmark

The bookmark subtree to add.

title: string

the title of the newly added subtree.

Returns:

void

Add a copy of a subtree as the new last child of a parent bookmark, and gives the subtree an initial title.

ConstructorRetrieve

static BookmarkConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

Bookmark

CreateNewChild

BookmarkCreateNewChild(Pagepage, stringtitle)

Parameters

page: Page

The PDF page of the new child bookmark.

title: string

The initial title of the new child bookmark.

Returns:

The newly created child bookmark.

(Deprecated, function may be removed in the future, use single-parameter CreateNewChild() method instead) Create a bookmark and add to a parent as the last child bookmark, and give the new bookmark an initial title.

CreateNewChild

BookmarkCreateNewChild(stringtitle)

Parameters

title: string

The initial text of the new child bookmark.

Returns:

The newly created child bookmark.

Create a new bookmark and add to a parent as the last child bookmark, using supplied string as the initial text.

CreateNewSibling

BookmarkCreateNewSibling(stringtitle)

Parameters

title: string

The initial text for the new right sibling.

Returns:

The newly created sibling bookmark.

Create a new bookmark in a tree as the next (right) sibling, using supplied string as the initial text.

Destroy

voidDestroy()

Returns:

void

Removes a bookmark subtree from the bookmark tree containing it.

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

Equals

override boolEquals(objectobj)

Parameters

obj: object

Returns:

override bool

FindDescendentBookmark

BookmarkFindDescendentBookmark(stringtitle)

Parameters

title: string

The title of the bookmark for which to search.

Returns:

The bookmark within this bookmark's tree that has the supplied title. Returns NULL if there is no bookmark with the supplied title.

Find bookmark by its title within the subtree of which this bookmark is the root, searching within the entire subtree.

FindDescendentBookmark

BookmarkFindDescendentBookmark(stringtitle, intmaxDepth)

Parameters

title: string

The title of the bookmark for which to search.

maxDepth: int

If supplied, declares the number of levels below this bookmark to search. (If omitted, the entire subtree is searched.)

Returns:

The bookmark within this bookmark's tree that has the supplied title. Returns NULL if there is no bookmark with the supplied title.

Find bookmark by its title within the subtree of which this bookmark is the root, searching within the subtree to a depth determined by maxDepth (e.g., 0 = this bookmark only and not any of its children, 1 = search one level below this bookmark level, etc.)

HasChildren

boolHasChildren()

Returns:

true if the bookmark has children.

Does the bookmark have children?

IsOpen

boolIsOpen()

Returns:

true if the bookmark is open.

Is the bookmark open?

SameTypeEquals

boolSameTypeEquals(Bookmarkarg0)

Parameters

arg0: Bookmark

Returns:

bool

ToString

override stringToString()

Returns:

override string