Back to Devexpress

SubDocument.Bookmarks Property

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-subdocument-ee0a7c15.md

latest5.8 KB
Original Source

SubDocument.Bookmarks Property

Provides access to the collection of document bookmarks.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
BookmarkCollection Bookmarks { get; }
vb
ReadOnly Property Bookmarks As BookmarkCollection

Property Value

TypeDescription
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.

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.

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

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

winforms-richedit-iterate-through-all-sub-documents/CS/Form1.cs#L31

csharp
for (int i = subdoc.Bookmarks.Count - 1; i >= 0; i--)
        subdoc.Bookmarks.Remove(subdoc.Bookmarks[i]);
}));

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

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

word-document-api-iterate-through-all-sub-documents/CS/Program.cs#L45

csharp
for (int i = subdoc.Bookmarks.Count - 1; i >= 0; i--)
        subdoc.Bookmarks.Remove(subdoc.Bookmarks[i]);
}));

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

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

winforms-richedit-iterate-through-all-sub-documents/VB/Form1.vb#L22

vb
For i As Integer = subdoc.Bookmarks.Count - 1 To 0 Step -1
    subdoc.Bookmarks.Remove(subdoc.Bookmarks(i))
Next

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

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

word-document-api-iterate-through-all-sub-documents/VB/Program.vb#L40

vb
For i As Integer = subdoc.Bookmarks.Count - 1 To 0 Step -1
    subdoc.Bookmarks.Remove(subdoc.Bookmarks(i))
Next

See Also

Create

Remove(Bookmark)

Select(Bookmark)

SubDocument Interface

SubDocument Members

DevExpress.XtraRichEdit.API.Native Namespace