SubDocument.Bookmarks Property

Provides access to the collection of document bookmarks.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

BookmarkCollection Bookmarks { get; }

VB.NET

ReadOnly Property Bookmarks As BookmarkCollection

Property Value

Type	Description
BookmarkCollection	A BookmarkCollection object specifying a bookmarks collection.

Remarks

Use the BookmarkCollection.Create method to create a new bookmark. To remove the bookmark, use the BookmarkCollection.Remove method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Bookmarks 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#L66

List<Bookmark> bookmarksAtRight = new List<Bookmark>();
foreach (Bookmark bookmark in document.Bookmarks) {
    if (bookmark.Range.Start.ToInt() == oldBookmarkStart.ToInt())

how-to-navigate-through-bookmarks-in-code-e4891/CS/WindowsFormsApplication1/Form1.cs#L35

if(currentBookMarkIndex > 0) {
    richEditControl1.Document.SelectBookmark(richEditControl1.Document.Bookmarks[currentBookMarkIndex - 1]);
}

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

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

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/DocumentPropertiesActions.cs#L52

document.CustomProperties["MyStringProperty"] = "The Final Answer";
document.CustomProperties["MyBookmarkProperty"] = document.Bookmarks[0];
document.CustomProperties["MyBooleanProperty"] = true;

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/DocumentProperties.cs#L49

document.CustomProperties["MyStringProperty"]="The Final Answer";
document.CustomProperties["MyBookmarkProperty"] = document.Bookmarks[0];
document.CustomProperties["MyBooleanProperty"]=true;

VB.NET

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

Dim bookmarksAtRight As New List(Of Bookmark)()
For Each bookmark As Bookmark In document.Bookmarks
    If bookmark.Range.Start.ToInt() = oldBookmarkStart.ToInt() Then

how-to-navigate-through-bookmarks-in-code-e4891/VB/WindowsFormsApplication1/Form1.vb#L37

If currentBookMarkIndex > 0 Then
    richEditControl1.Document.SelectBookmark(richEditControl1.Document.Bookmarks(currentBookMarkIndex - 1))
End If

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

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

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/DocumentPropertiesActions.vb#L48

document.CustomProperties("MyStringProperty") = "The Final Answer"
document.CustomProperties("MyBookmarkProperty") = document.Bookmarks(0)
document.CustomProperties("MyBooleanProperty") = True

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/DocumentProperties.vb#L47

document.CustomProperties("MyStringProperty")="The Final Answer"
document.CustomProperties("MyBookmarkProperty") = document.Bookmarks(0)
document.CustomProperties("MyBooleanProperty")=True