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

DxRichEdit.LoadDocumentAsync(IBrowserFile, CancellationToken) Method

Loads a document from a file.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

#Declaration

C#
public ValueTask LoadDocumentAsync(
    IBrowserFile file,
    CancellationToken cancellationToken = default(CancellationToken)
)

#Parameters

Name Type Description
file IBrowserFile

The file to load.

#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

Call the LoadDocumentAsync method to load a document from a file.

The DocumentLoaded event occurs after the Rich Text Editor loads a document. Handle this event to change the content of a loaded document.

The following code snippet loads a document from a file:

Razor
<InputFile OnChange="OnChange" />
<DxRichEdit @ref="richEdit" />
@code {
    DxRichEdit richEdit { get; set; }
    private async Task OnChange(InputFileChangeEventArgs eventArgs) {
        /* 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 {
            IBrowserFile file = eventArgs.File;
            await richEdit.LoadDocumentAsync(file);
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
    }
}
See Also