Hyperlinks.RemoveAsync(Int32, CancellationToken) Method

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

Namespace: DevExpress.Blazor.RichEdit

Assembly: DevExpress.Blazor.RichEdit.v22.1.dll

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

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

Parameters

Name	Type	Description
index	Int32	The hyperlink 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

<DxRichEdit @ref="richEdit" />
@code {
    DxRichEdit richEdit;
    Document documentAPI;
    @* ... *@
    /* 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 cancelled. */
        try {
            documentAPI = richEdit.DocumentAPI;
            @* ... *@
            // Remove the first hyperlink
            await documentAPI.Hyperlinks.RemoveAsync(0);
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}