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

SubDocument.RemoveAsync(Int32, Int32, CancellationToken) Method

Removes the specified text interval.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

#Declaration

C#
public ValueTask<int> RemoveAsync(
    int startPosition,
    int length,
    CancellationToken cancellationToken = default(CancellationToken)
)

#Parameters

Name Type Description
startPosition Int32

The interval start position.

length Int32

The interval length.

#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 example deletes a paragraph mark and joins the first paragraph’s content with the second paragraph’s content:

Razor
<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.Start + firstParagraph.Interval.Length - 1, 1);
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}
See Also