Class BookmarksCollection

Namespace

EvoPdf

Assembly

evohtmltopdf.dll

Represents a collection of bookmarks of a document.

[ClassInterface(ClassInterfaceType.AutoDual)]
public class BookmarksCollection : IEnumerable

Inheritance

object

BookmarksCollection

Implements

IEnumerable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Count

The number of bookmarks in this PDF bookmarks collection

public int Count { get; }

Property Value

int

Document

The parent document of this collection

public Document Document { get; }

Property Value

Document

this[int]

Gets the bookmark at the specified zero based index in the bookmarks collection.

public Bookmark this[int bookmarkIndex] { get; }

Parameters

bookmarkIndex int

The zero based bookmark index in the collection.

Property Value

Bookmark

The PDF bookmark at the specified index

Methods

AddNewBookmark(string, ExplicitDestination)

Adds a new bookmark to the collection.

public Bookmark AddNewBookmark(string text, ExplicitDestination destination)

Parameters

text string

The bookmark text.

destination ExplicitDestination

The bookmark destination.

Returns

Bookmark

The newly created PDF bookmark.

GetEnumerator()

Gets the collection enumerator.

public IEnumerator GetEnumerator()

Returns

IEnumerator

The collection enumerator.

InsertNewBookmark(int, string, ExplicitDestination)

Creates a new bookmark and inserts it at the specified zero based position index in collection.

public Bookmark InsertNewBookmark(int positionIndex, string text, ExplicitDestination destination)

Parameters

positionIndex int

The zero based position index where to insert the bookmark.

text string

The bookmark text.

destination ExplicitDestination

The bookmark destination.

Returns

Bookmark

The newly created PDF bookmark.

Remove(Bookmark)

Removes the specified PDF bookmark.

public void Remove(Bookmark bookmark)

Parameters

bookmark Bookmark

The PDF bookmark to be removed.

Remove(int)

Removes the PDF bookmark at the specified index in collection.

public void Remove(int bookmarkIndex)

Parameters

bookmarkIndex int

The zero based index of the PDF bookmark to be removed.

RemoveAll()

Removes all the bookmarks from collection

public void RemoveAll()