BookmarkEnd Class

Represents the end of a bookmark.

Inheritance Hierarchy

SystemObject
  GemBox.DocumentElement
    GemBox.DocumentInline
      GemBox.DocumentBookmarkEnd

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

Syntax

Copy

public sealed class BookmarkEnd : Inline

Public NotInheritable Class BookmarkEnd
	Inherits Inline

The BookmarkEnd type exposes the following members.

Constructors

	Name	Description
	BookmarkEnd	Initializes a new instance of the BookmarkEnd class.

Top

Properties

	Name	Description
	Content	Gets the content of the current Element. (Inherited from Element.)
	Document	Gets the owner document. (Inherited from Element.)
	ElementType	Gets the ElementType of this Element instance. (Overrides ElementElementType.)
	Name	Gets the name of this bookmark.
	Parent	Gets the parent of this Element instance. (Inherited from Element.)
	ParentCollection	Gets the InlineCollection that contains this Inline instance. (Inherited from Inline.)

Top

Methods

	Name	Description
	Clone	Clones this BookmarkEnd instance.
	Clone(Boolean)	Clones this Inline instance. (Inherited from Inline.)
	GetChildElements(Boolean)	Gets the child elements. (Inherited from Element.)
	GetChildElements(Boolean, ElementType)	Gets the child elements filtered by ElementType. (Inherited from Element.)

Top

Remarks

BookmarkEnd element is used in a pair with BookmarkStart element to bookmark a specific part of the document with a specific name.

For BookmarkStart and BookmarkEnd to be considered as a pair, their names must match.

BookmarkEnd is an inline element. For more information about GemBox.Document document content model, see Content Model.

To easily navigate and manipulate over all bookmarks in the document, GemBox.Document also contains a Bookmark class that serves as a façade for BookmarkStart and BookmarkEnd elements. Bookmark objects can be retrieved from DocumentModel.Bookmarks collection.

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 and Modify Bookmarks examples.

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