SubDocument.RemoveAsync(Interval, CancellationToken) Method

Removes the specified text interval.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask<int> RemoveAsync(
    Interval interval,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name	Type	Description
interval	Interval	The text interval to remove.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	An object that propagates a cancellation notification.

Returns

Type	Description
ValueTask<Int32>	A structure that stores an awaitable result of an asynchronous operation. The awaitable result is an integer value that indicates the number of items deleted, or 0 (zero) if the deletion was unsuccessful.

Remarks

The following code sample removes the first paragraph from the document:

<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 canceled. */
        try {
            documentAPI = richEdit.DocumentAPI;
            Paragraph firstParagraph = await documentAPI.Paragraphs.GetAsync(0);
            await documentAPI.RemoveAsync(firstParagraph.Interval);
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}