BookmarkStart Class

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents the start of a bookmark.

public sealed class BookmarkStart : Inline
Public NotInheritable Class BookmarkStart
    Inherits Inline
Inheritance:
System.Object
BookmarkStart
Remarks

BookmarkStart element is used in a pair with BookmarkEnd 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.

BookmarkStart 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

BookmarkStart(DocumentModel, String)

Initializes a new instance of the BookmarkStart class.

public BookmarkStart(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.

public override ElementType ElementType { get; }
Public Overrides ReadOnly Property ElementType As ElementType
Property Value
ElementType

The ElementType of this Element instance.

Overrides

Name

Gets the name of this bookmark.

public string Name { get; }
Public ReadOnly Property Name As String
Property Value
System.String

The name of this bookmark.

Methods

Clone()

Clones this BookmarkStart instance.

public BookmarkStart Clone()
Public Function Clone As BookmarkStart
Returns
BookmarkStart
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