Back to Devexpress

Workbook.ExportToHtmlAsync(Stream, Worksheet) Method

officefileapi-devexpress-dot-spreadsheet-dot-workbook-dot-exporttohtmlasync-x28-system-dot-io-dot-stream-devexpress-dot-spreadsheet-dot-worksheet-x29.md

latest4.1 KB
Original Source

Workbook.ExportToHtmlAsync(Stream, Worksheet) Method

Asynchronously exports the specified worksheet to the specified stream in HTML format.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public Task ExportToHtmlAsync(
    Stream stream,
    Worksheet sheet
)
vb
Public Function ExportToHtmlAsync(
    stream As Stream,
    sheet As Worksheet
) As Task

Parameters

NameTypeDescription
streamStream

A Stream object to which the created HTML file should be sent.

| | sheet | Worksheet |

A Worksheet object to be exported to HTML.

|

Returns

TypeDescription
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 call may occur in a different thread than the target operation.

  • The operation is not thread safe (the document should not be accessed simultaneously by different threads). Wait until the operation is completed before you continue to work with the document (for example, use the await operator).

Calculate Formulas Before Export

The default calculation mode for a Workbook is Manual. This mode implies that the Spreadsheet does not recalculate formulas before it generates an HTML file. Call the Workbook.Calculate or Workbook.CalculateFull method to calculate all formulas in the workbook before you export it to HTML.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToHtmlAsync(Stream, Worksheet) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

spreadsheet-document-api-create-loan-amortization-schedule-within-blazor-server-app/CS/BlazorAppSpreadsheet/Code/DocumentService.cs#L20

csharp
using var ms = new MemoryStream();
await workbook.ExportToHtmlAsync(ms, workbook.Worksheets[0]);
return ms.ToArray();

See Also

Workbook Class

Workbook Members

DevExpress.Spreadsheet Namespace