DxRichEdit.LoadDocumentAsync(Stream, CancellationToken) Method

Loads a document from a stream.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask LoadDocumentAsync(
    Stream stream,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name	Type	Description
stream	Stream	The stream from which to load a document.

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 stream. The Rich Text Editor automatically detects the document’s format. Override the Detect(Stream) method to implement your own file format detection logic.

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 an Office Open XML document from a file stream:

<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 {
        @* ... *@
            var fileStream = new FileStream("C:\\Users\\Public\\annual-report.docx", FileMode.Open);
            await richEdit.LoadDocumentAsync(fileStream);
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}

Call the LoadDocumentAsync(Stream, DocumentFormat, CancellationToken) method and pass the document format as a parameter to omit automatic detection and improve performance.