Bookmark.Name Property

Gets the name of a bookmark in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

string Name { get; }

VB.NET

ReadOnly Property Name As String

Property Value

Type	Description
String	A string that is the unique bookmark’s name.

Remarks

The bookmark name is used in the hyperlink as the Hyperlink.Anchor property value that, when the hyperlink is activated, the document location should navigate.

The Name should be unique in the SubDocument.Bookmarks collection. Specify the bookmark name when creating a bookmark using the SubDocument.CreateBookmark method or the CreateBookmarkCommand command. If the bookmark with the same name already exists, an exception is thrown in a situation when a bookmark is created using an API. If a bookmark is created by the end-user, a confirmation dialog appears displaying the text obtained from the XtraRichEditStringId.Msg_BookmarkCreationFailing resource string that reads “Bookmark with the same name already exists. Replace?”.

Related GitHub Examples

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

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#L72

int bookmarkEnd = bookmark.Range.End.ToInt();
string bookmarkName = bookmark.Name;
document.Bookmarks.Remove(bookmark);

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

    string textFragment = richEditControl1.Document.GetText(bm.Range);
    textBlock1.Text = String.Format("You are over a bookmark '{0}' containing text: '{1}'", bm.Name, textFragment);
}

VB.NET

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

Dim bookmarkEnd As Integer = bookmark.Range.End.ToInt()
Dim bookmarkName As String = bookmark.Name
document.Bookmarks.Remove(bookmark)

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

    Dim textFragment As String = richEditControl1.Document.GetText(bm.Range)
    textBlock1.Text = String.Format("You are over a bookmark '{0}' containing text: '{1}'", bm.Name, textFragment)
End Sub