ReadOnlyBookmarkCollection.Get(DocumentRange) Method

Gets all bookmarks located in the specified document range.

Namespace: DevExpress.XtraRichEdit.API.Native

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

ReadOnlyBookmarkCollection Get(
    DocumentRange range
)

VB.NET

Function Get(
    range As DocumentRange
) As ReadOnlyBookmarkCollection

Parameters

Name	Type	Description
range	DocumentRange	A DocumentRange specifying the range in which to search for bookmarks.

Returns

Type	Description
ReadOnlyBookmarkCollection	A ReadOnlyBookmarkCollection object specifying the read-only collection of bookmarks.

Remarks

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:

C#

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);
        }
    }
}

VB.NET

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