Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

Bookmarks.RemoveAsync(Int32, CancellationToken) Method

Removes a bookmark with the specified index from the sub-document.

Namespace: DevExpress.Blazor.RichEdit

Assembly: DevExpress.Blazor.RichEdit.v24.2.dll

NuGet Package: DevExpress.Blazor.RichEdit

#Declaration

C#
public ValueTask RemoveAsync(
    int index,
    CancellationToken cancellationToken = default(CancellationToken)
)

#Parameters

Name Type Description
index Int32

The bookmark index in the collection.

#Optional Parameters

Name Type Default Description
cancellationToken CancellationToken null

An object that propagates a cancellation notification.

#Returns

Type Description
ValueTask

A structure that stores an awaitable result of an asynchronous operation.

#Remarks

Razor
<DxRichEdit @ref="@richEdit" />

@code {
    DxRichEdit richEdit { get; set; }
    /* Surround the code that contains an asynchronous operation with a try-catch block to handle
    the OperationCanceledException. This exception is thrown when an asynchronous operation is canceled. */
        try {
            var bookmarks = await richEdit.DocumentAPI.Bookmarks.GetAllAsync();
            // Remove all bookmarks from the document
            while (bookmarks.Count > 0) {
                await richEdit.DocumentAPI.Bookmarks.RemoveAsync(0);
                bookmarks = await richEdit.DocumentAPI.Bookmarks.GetAllAsync();
            }
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}
See Also