Back to Devexpress

Bookmarks.RemoveAsync(Bookmark, CancellationToken) Method

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

latest2.1 KB
Original Source

Bookmarks.RemoveAsync(Bookmark, CancellationToken) Method

Removes the specified bookmark 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(
    Bookmark bookmark,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

NameTypeDescription
bookmarkBookmark

The bookmark to be removed.

|

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 firstBookmark = await richEdit.DocumentAPI.Bookmarks.GetAsync(0);
            // Remove the first bookmark
            await richEdit.DocumentAPI.Bookmarks.RemoveAsync(firstBookmark);
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

See Also

Bookmarks Class

Bookmarks Members

DevExpress.Blazor.RichEdit Namespace