Back to Devexpress

DxRichEdit.NewDocumentAsync(CancellationToken) Method

blazor-devexpress-dot-blazor-dot-richedit-dot-dxrichedit-dot-newdocumentasync-x28-system-dot-threading-dot-cancellationtoken-x29.md

latest2.1 KB
Original Source

DxRichEdit.NewDocumentAsync(CancellationToken) Method

Creates and opens a new document.

Namespace : DevExpress.Blazor.RichEdit

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

NuGet Package : DevExpress.Blazor.RichEdit

Declaration

csharp
public ValueTask NewDocumentAsync(
    CancellationToken cancellationToken = default(CancellationToken)
)

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

The DocumentLoaded event occurs after the Rich Text Editor successfully creates or opens a document. Handle this event to change the content of a new document.

The following code snippet creates a document:

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 {
        @* ... *@
            await richEdit.NewDocumentAsync();
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

See Also

Document Management in Blazor Rich Text Editor

DxRichEdit Class

DxRichEdit Members

DevExpress.Blazor.RichEdit Namespace