BookmarkEnd Class

Namespace:

GemBox.Document

Assembly:

GemBox.Document.dll

Represents the end of a bookmark.

• C#
• VB.NET

public sealed class BookmarkEnd : Inline

Public NotInheritable Class BookmarkEnd
    Inherits Inline

Inheritance:

System.Object

Element

Inline

BookmarkEnd

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 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.

Constructors

BookmarkEnd(DocumentModel, String)

Initializes a new instance of the BookmarkEnd class.

• C#
• VB.NET

public BookmarkEnd(DocumentModel document, string name)

Public Sub New(document As DocumentModel, name As String)

Parameters

document

DocumentModel

The owner document.

name

System.String

The bookmark name.

Properties

ElementType

Gets the ElementType of this Element instance.

• C#
• VB.NET

public override ElementType ElementType { get; }

Public Overrides ReadOnly Property ElementType As ElementType

Property Value

ElementType

The ElementType of this Element instance.

Overrides

Element.ElementType

Name

Gets the name of this bookmark.

• C#
• VB.NET

public string Name { get; }

Public ReadOnly Property Name As String

Property Value

System.String

The name of this bookmark.

Methods

Clone()

Clones this BookmarkEnd instance.

• C#
• VB.NET

public BookmarkEnd Clone()

Public Function Clone As BookmarkEnd

Returns

BookmarkEnd

Cloned BookmarkEnd.

Remarks

Document content element instance can exist only in a one place in the document.

If you want to insert document content element into some other part of the same document, then clone the element and insert its clone.

If you want to insert document content element into another document, then you should first import it into another document with Import<T>(T, Boolean, Boolean) method and then insert the imported element.

For more information, see cloning example.

Inherited Properties

Content	Gets the content of the current Element. (Inherited from Element)
Document	Gets the owner document. (Inherited from Element)
Parent	Gets the parent of this Element instance. (Inherited from Element)
ParentCollection	Gets the InlineCollection that contains this Inline instance. (Inherited from Inline)
Revision	Gets or sets the revision information for the inline. (Inherited from Inline)

Inherited Methods

Clone(System.Boolean)	Clones this Inline instance. (Inherited from Inline)
GetChildElements(System.Boolean)	Gets the child elements. (Inherited from Element)
GetChildElements(System.Boolean, ElementType[])	Gets the child elements filtered by ElementType. (Inherited from Element)
GetParentElements()	Gets the parent elements. (Inherited from Element)
GetParentElements(ElementType[])	Gets the parent elements. (Inherited from Element)

See Also

Bookmarks

Bookmark

BookmarkStart