DxRichEdit.ExportDocumentAsync(String, DocumentFormat, CancellationToken) Method

Exports the document to a file in a specified format.

Namespace : DevExpress.Blazor.RichEdit

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

NuGet Package : DevExpress.Blazor.RichEdit

Declaration

csharp

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

Parameters

Name	Type	Description
filePath	String

The path to the output file.

| | 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

A structure that stores an awaitable result of an asynchronous operation.

Remarks

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

razor

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