SubDocument.ReplaceAllAsync(String, String, Boolean, CancellationToken) Method

Finds all matches of the specified string in the sub-document and replaces them with a specific string.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask<int> ReplaceAllAsync(
    string text,
    string replaceText,
    bool matchCase,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name	Type	Description
text	String	The string that should be replaced.
replaceText	String	The replacement string.
matchCase	Boolean	true to perform a case-sensitive search; otherwise, false.

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 replacements.

Remarks

The example below replaces all “cat” strings with “dog” strings.

<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;
            await documentAPI.ReplaceAllAsync("cat", "dog", false);
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
        @* ... *@
}