Workbook.ExportToHtmlAsync(Stream, HtmlDocumentExporterOptions, CancellationToken) Method
Asynchronously exports the document’s data to the specified stream in HTML format using the specified options.
You need a license to the DevExpress Office File API or DevExpress Universal Subscription to use this method in production code.
Namespace: DevExpress.Spreadsheet
Assembly: DevExpress.Docs.v19.2.dll
Declaration
Parameters
Name | Type | Description |
---|---|---|
stream | Stream | A Stream object to which the created HTML file should be sent. |
options | HtmlDocumentExporterOptions | A HtmlDocumentExporterOptions instance containing required export options. |
cancellationToken | CancellationToken | A CancellationToken object used to trace the requests to cancel an operation. |
Returns
Type | Description |
---|---|
Task | An Task object representing an asynchronous export operation. |
Remarks
Important
Take into account the following when you call this method:
The events fired by this method’s call may occur in a different thread than the target operation.
The operation is not thread safe (documents should not be accessed simultaneously by different threads). Wait until the operation is completed before working with the document, i.e., use the
await
operator.
The code sample below asynchronously exports the first worksheet of the loaded XLSX document to HTML using the CancellationToken object:
private async void ConvertXlsx2HtmlWithCancellation()
{
using (CancellationTokenSource source = new CancellationTokenSource(10000))
{
using (Workbook workbook = new Workbook())
{
try
{
await workbook.LoadDocumentAsync("Document.xlsx", source.Token);
await workbook.ExportToHtmlAsync("Result.html", 0, source.Token);
}
catch (OperationCanceledException)
{
// Your code to handle cancellation.
}
}
}
}