officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-readonlybookmarkcollection-dot-get-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentrange-x29.md
Gets all bookmarks located in the specified document range.
Namespace : DevExpress.XtraRichEdit.API.Native
Assembly : DevExpress.RichEdit.v25.2.Core.dll
NuGet Package : DevExpress.RichEdit.Core
ReadOnlyBookmarkCollection Get(
DocumentRange range
)
Function Get(
range As DocumentRange
) As ReadOnlyBookmarkCollection
| Name | Type | Description |
|---|---|---|
| range | DocumentRange |
A DocumentRange specifying the range in which to search for bookmarks.
|
| Type | Description |
|---|---|
| ReadOnlyBookmarkCollection |
A ReadOnlyBookmarkCollection object specifying the read-only collection of bookmarks.
|
The Get method returns a collection of Bookmark objects contained in the specified range.
Note
If you operate with a selection range, the Get method should be enclosed within a DocumentRange.BeginUpdateDocument - DocumentRange.EndUpdateDocument method pair. Otherwise, an incorrect document model might be selected, resulting in an exception “Error: specified document position or range belongs to other document or subdocument” being thrown.
The code sample below shows how to locate and remove bookmarks in the 6th paragraph:
using DevExpress.XtraRichEdit.API.Native;
using (RichEditDocumentServer wordProcessor = new RichEditDocumentServer())
{
Document document = wordProcessor.Document;
ReadOnlyBookmarkCollection bookmarks =
document.Bookmarks.Get(document.Paragraphs[5].Range);
if (bookmarks != null)
{
foreach (Bookmark bookmark in bookmarks)
{
document.Bookmarks.Remove(bookmark);
}
}
}
Imports DevExpress.XtraRichEdit.API.Native
Using wordProcessor As New RichEditDocumentServer()
Dim document As Document = wordProcessor.Document
Dim bookmarks As ReadOnlyBookmarkCollection =
document.Bookmarks.Get(document.Paragraphs(5).Range)
If bookmarks IsNot Nothing Then
For Each bookmark As Bookmark In bookmarks
document.Bookmarks.Remove(bookmark)
Next bookmark
End If
End Using
See Also
ReadOnlyBookmarkCollection Interface