DxRichEdit.LoadDocumentAsync(Stream, DocumentFormat) Method
Loads a document in the specified format from a stream.
Namespace: DevExpress.Blazor.RichEdit
Assembly: DevExpress.Blazor.RichEdit.v21.2.dll
NuGet Package: DevExpress.Blazor.RichEdit
Declaration
public ValueTask LoadDocumentAsync(
Stream stream,
DocumentFormat documentFormat
)
Parameters
Name | Type | Description |
---|---|---|
stream | Stream | The stream from which to load a document. |
documentFormat | DocumentFormat | The format of the loaded document. |
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 stream.
The DocumentLoaded event occurs after the Rich Text Editor loads a document. Handle this event to change the content of a loaded document.
The example below 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 cancelled. */
try {
@* ... *@
var fileStream = new FileStream("C:\\Users\\Public\\annual-report.docx", FileMode.Open);
await richEdit.LoadDocumentAsync(fileStream, DocumentFormat.OpenXml);
@* ... *@
}
catch (OperationCanceledException e) {
Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
}
}
See Also