Bookmark Interface

Defines a bookmark in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v22.1.Core.dll

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.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Bookmark interface.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-insert-text-between-two-bookmarks-e4405/CS/CS/BookmarkInsertLR/Form1.cs#L65

document.BeginUpdate();
List<Bookmark> bookmarksAtRight = new List<Bookmark>();
foreach (Bookmark bookmark in document.Bookmarks) {

dxrichedit-for-wpf-how-to-use-hit-testing-e2765/CS/DXRichEdit_HitTest/MainWindow.xaml.cs#L66

{
    foreach (Bookmark bm in bmCollection)
    {

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/CS/WindowsFormsApplication1/Form1.cs#L33

for(int i = 0; i < document.Bookmarks.Count; i++) {
    Bookmark protectedBookmark = document.Bookmarks[i];
    if(protectedBookmark.Name.Contains("protectedRange")) {

VB.NET

how-to-insert-text-between-two-bookmarks-e4405/VB/CS/BookmarkInsertLR/Form1.vb#L67

document.BeginUpdate()
Dim bookmarksAtRight As New List(Of Bookmark)()
For Each bookmark As Bookmark In document.Bookmarks

dxrichedit-for-wpf-how-to-use-hit-testing-e2765/VB/DXRichEdit_HitTest/MainWindow.xaml.vb#L58

If pos IsNot Nothing Then
    For Each bm As Bookmark In bmCollection
        If bm.Range.Contains(pos) Then

how-to-create-protected-ranges-in-a-document-depending-on-service-bookmarks-t466775/VB/WindowsFormsApplication1/Form1.vb#L35

For i As Integer = 0 To document.Bookmarks.Count - 1
    Dim protectedBookmark As Bookmark = document.Bookmarks(i)
    If protectedBookmark.Name.Contains("protectedRange") Then