Bookmark Interface

Defines a bookmark in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[ComVisible(true)]
public interface Bookmark

VB.NET

<ComVisible(True)>
Public Interface Bookmark

Related API Members

The following members return Bookmark objects:

• BookmarkCollection.Create(DocumentPosition, Int32, String)
• BookmarkCollection.Create(DocumentRange, String)
• BookmarkCollection.Item[String]

Remarks

A Bookmark exposes a document range with a name. A range can have zero length. The name should start with a letter, and must be unique in the collection of bookmarks in the current document. This collection is accessible with the SubDocument.Bookmarks property.

To create a new bookmark, use the BookmarkCollection.Create method. The BookmarkCollection.Select method is helpful if you want to select a bookmark. The BookmarkCollection.Remove method deletes the specified bookmark.

Apart from the Document methods, the XtraRichEdit provides several commands for bookmarks - the CreateBookmarkCommand and the ShowBookmarkFormCommand.

Bookmarks in the document can be referenced by a Hyperlink. The Hyperlink.Anchor property specifies the bookmark to which the hyperlink is pointing.