All docs
V21.2
21.2
21.1
20.2
The page you are viewing does not exist in version 20.2. This link will take you to the root page.
20.1
The page you are viewing does not exist in version 20.1. This link will take you to the root page.
19.2
The page you are viewing does not exist in version 19.2. This link will take you to the root page.
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

Workbook.ExportToHtmlAsync(Stream, Worksheet, IProgress<Int32>) Method

Asynchronously exports the specified worksheet to a stream in HTML format and allows you to implement progress notifications.

You need an active 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.v21.2.dll

Declaration

public Task ExportToHtmlAsync(
    Stream stream,
    Worksheet sheet,
    IProgress<int> progress
)

Parameters

Name Type Description
stream Stream

Specifies the output stream.

sheet Worksheet

A worksheet to save as HTML.

progress IProgress<Int32>

An object used to report the task progress in percentage. Use a Progress<T> class instance to report progress.

Returns

Type Description
Task

An object that defines the 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).

Example: Report Progress of Workbook Operations

The following example asynchronously loads a workbook and exports the first worksheet to HTML. The console window displays the progress of each operation.

using System;
using System.IO;
using System.Threading.Tasks;
using DevExpress.Spreadsheet;
// ...

static async Task Main(string[] args) {
    using (Workbook workbook = new Workbook())
    {
        Console.WriteLine("Loading a document...");
        await workbook.LoadDocumentAsync("Document.xlsx",
            new Progress<int>((progress) => Console.WriteLine($"{progress}%")));
        Worksheet worksheet = workbook.Worksheets[0];
        Console.WriteLine("Exporting to HTML...");
        using (FileStream htmlStream = new FileStream("HtmlDocument.html", FileMode.Create))
        {
            await workbook.ExportToHtmlAsync(htmlStream, worksheet,
                new Progress<int>((progress) => Console.WriteLine($"{progress}%")));
        }
        Console.WriteLine("Done!");
    }
}

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.

See Also