ReadOnlyBookmarkCollection Interface

A collection of Bookmark objects in the document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

[ComVisible(true)]
public interface ReadOnlyBookmarkCollection :
    ISimpleCollection<Bookmark>,
    IEnumerable<Bookmark>,
    IEnumerable,
    ICollection

VB.NET

<ComVisible(True)>
Public Interface ReadOnlyBookmarkCollection
    Inherits ISimpleCollection(Of Bookmark),
             IEnumerable(Of Bookmark),
             IEnumerable,
             ICollection

Related API Members

The following members return ReadOnlyBookmarkCollection objects:

• ReadOnlyBookmarkCollection.Get(DocumentRange)

Remarks

Contains a ReadOnlyBookmarkCollection.Get method that obtains all bookmarks located in the specified document range. You can access individual items of this collection, but you cannot add or delete items. Use index notation to obtain an individual Bookmark object from this collection.

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