DxRichEdit.ExportDocumentAsync(DocumentFormat, CancellationToken) Method

Exports the document to a byte array in a specified format.

Namespace: DevExpress.Blazor.RichEdit

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

NuGet Package: DevExpress.Blazor.RichEdit

Declaration

public ValueTask<byte[]> ExportDocumentAsync(
    DocumentFormat documentFormat,
    CancellationToken cancellationToken = default(CancellationToken)
)

Parameters

Name	Type	Description
documentFormat	DocumentFormat	The output document format.

Optional Parameters

Name	Type	Default	Description
cancellationToken	CancellationToken	null	An object that propagates a cancellation notification.

Returns

Type	Description
ValueTask<Byte[]>	A structure that stores an awaitable result of an asynchronous operation. The awaitable result is a byte array that contains data in the specified format.

Remarks

The following code snippet exports the document to the RTF and saves it to a byte array.

<DxRichEdit @ref="richEdit1" />
<DxRichEdit @ref="richEdit2" />
@code {
    DxRichEdit richEdit1 { get; set; }
    DxRichEdit richEdit2 { 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 {
            byte[] fileContent = await richEdit1.ExportDocumentAsync(DocumentFormat.Rtf);
            await richEdit2.LoadDocumentAsync(fileContent, DocumentFormat.Rtf);
        }
        catch (OperationCanceledException e) {
            Console.WriteLine($"{nameof(OperationCanceledException)} thrown with message: {e.Message}");
        }
}