DxRichEdit.LoadDocumentAsync(String, DocumentFormat, CancellationToken) Method

Loads a document in the specified format from a file.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask LoadDocumentAsync(
    string filePath,
    DocumentFormat documentFormat,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name	Type	Description
filePath	String	The path to the file to load.
documentFormat	DocumentFormat	The format of the loaded 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 in the specified format 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 an Office Open XML document from a file:

<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.LoadDocumentAsync("C:\\Users\\Public\\annual-report.docx", DocumentFormat.OpenXml);
            @* ... *@
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}