BookmarkCollection Class

Represents a collection of Bookmarks.

Inheritance Hierarchy

SystemObject
GemBox.DocumentBookmarkCollection

Namespace: GemBox.Document
Assembly: GemBox.Document (in GemBox.Document.dll) Version: 29.0.35.1167

Syntax

Copy

public sealed class BookmarkCollection : IList<Bookmark>, 
	ICollection<Bookmark>, IEnumerable<Bookmark>, IEnumerable

Public NotInheritable Class BookmarkCollection
	Implements IList(Of Bookmark), ICollection(Of Bookmark), 
	IEnumerable(Of Bookmark), IEnumerable

The BookmarkCollection type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of Bookmarks contained in the BookmarkCollection.
	ItemInt32	Gets the Bookmark at the specified index.
	ItemString	Gets the Bookmark with the specified name.

Top

Methods

	Name	Description
	Clear	Removes all items from the ICollectionT.
	Contains	Determines whether the ICollectionT contains a specific value.
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	IndexOf	Determines the index of a specific item in the IListT.
	Remove	Removes the first occurrence of a specific object from the ICollectionT.
	RemoveAt	Removes the IListT item at the specified index.

Top

Remarks

BookmarkCollection is used in a DocumentModel.Bookmarks property.

DocumentModel.Bookmarks collection contains all bookmarks in the document. Use DocumentModel.Bookmarks collection to retrieve a Bookmark with a specified name, iterate over all bookmarks or remove a bookmark.

Bookmarks are usually used in a conjunction with Hyperlinks or Fields for navigating to a bookmarked part of the document or to render a page number (or some other information) of a bookmarked part of the document. For more information, see Bookmarks and Hyperlinks example.

Examples

Following example shows how to insert a bookmarked content to a document, and later retrieve and delete it through DocumentModel.Bookmarks collection.

Copy

// Create a new empty document.
var doc = new DocumentModel();

// Insert a bookmarked text.
doc.Sections.Add(
    new Section(doc, 
        new Paragraph(doc, 
            new BookmarkStart(doc, "MyBookmark"), 
            new Run(doc, "My bookmarked text"), 
            new BookmarkEnd(doc, "MyBookmark"))));


// Retrieve a bookmark.
var myBookmark = doc.Bookmarks["MyBookmark"];

// Delete a bookmark. Deletes BookmarkStart and BookmarkEnd elements. Content that was bookmarked will not be deleted!
doc.Bookmarks.Remove(myBookmark);

' Create a new empty document.
Dim doc = New DocumentModel()

' Insert a bookmarked text.
doc.Sections.Add(
    New Section(doc,
        New Paragraph(doc,
            New BookmarkStart(doc, "MyBookmark"),
            New Run(doc, "My bookmarked text"),
            New BookmarkEnd(doc, "MyBookmark"))))


' Retrieve a bookmark.
Dim myBookmark = doc.Bookmarks("MyBookmark")

' Delete a bookmark. Deletes BookmarkStart and BookmarkEnd elements. Content that was bookmarked will not be deleted!
doc.Bookmarks.Remove(myBookmark)

Reference

GemBox.Document Namespace

DocumentModelBookmarks

GemBox.DocumentBookmark

GemBox.DocumentBookmarkStart

GemBox.DocumentBookmarkEnd