Back to Devexpress

Bookmarks.RemoveAsync(Int32, CancellationToken) Method

blazor-devexpress-dot-blazor-dot-richedit-dot-bookmarks-dot-removeasync-x28-system-dot-int32-system-dot-threading-dot-cancellationtoken-x29.md

latest2.2 KB
Original Source

Bookmarks.RemoveAsync(Int32, CancellationToken) Method

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

Namespace : DevExpress.Blazor.RichEdit

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

NuGet Package : DevExpress.Blazor.RichEdit

Declaration

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

Parameters

NameTypeDescription
indexInt32

The bookmark index in the collection.

|

Optional Parameters

NameTypeDefaultDescription
cancellationTokenCancellationTokennull

An object that propagates a cancellation notification.

|

Returns

TypeDescription
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

Bookmarks Class

Bookmarks Members

DevExpress.Blazor.RichEdit Namespace