IWorkbook.ExportToHtml(Stream, Int32) Method

Exports the specified worksheet to the specified stream in HTML format.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void ExportToHtml(
    Stream stream,
    int sheetIndex
)

VB.NET

Sub ExportToHtml(
    stream As Stream,
    sheetIndex As Integer
)

Parameters

Name	Type	Description
stream	Stream	A Stream object to which the created HTML file should be sent.
sheetIndex	Int32	An integer value that is the index of the worksheet to be exported to HTML.

Example

The example below demonstrates how to save a worksheet and a cell range as HTML files using the IWorkbook.ExportToHtml method overloads. To specify export options, create an instance of the HtmlDocumentExporterOptions class and pass it as a parameter to the ExportToHtml method.

View Example

ExportActions.vb

workbook.LoadDocument("Documents\ExpenseReport.xlsx")
workbook.Calculate()
Dim worksheet As Worksheet = workbook.Worksheets(0)

' Create an object containing HTML export options.
Dim options As New HtmlDocumentExporterOptions()

' Set HTML-specific export options.
options.CssPropertiesExportType = DevExpress.XtraSpreadsheet.Export.Html.CssPropertiesExportType.Style
options.Encoding = Encoding.UTF8

' Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index
options.Range = "B11:O28"

' Export a document to an HTML file with the specified options.
workbook.ExportToHtml("OutputRange.html", options)

' Export the entire worksheet to a stream as HTML.
Dim htmlStream As New FileStream("OutputWorksheet.html", FileMode.Create)
workbook.ExportToHtml(htmlStream, worksheet.Index)

ExportActions.cs

workbook.LoadDocument("Documents\\ExpenseReport.xlsx");
workbook.Calculate();
Worksheet worksheet = workbook.Worksheets[0];

// Create an object containing HTML export options.
HtmlDocumentExporterOptions options = new HtmlDocumentExporterOptions();

// Set HTML-specific export options.
options.CssPropertiesExportType = DevExpress.XtraSpreadsheet.Export.Html.CssPropertiesExportType.Style;
options.Encoding = Encoding.UTF8;

// Specify the part of the document to be exported to HTML.
options.SheetIndex = worksheet.Index;
options.Range = "B11:O28";

// Export a document to an HTML file with the specified options.
workbook.ExportToHtml("OutputRange.html", options);

// Export the entire worksheet to a stream as HTML.
FileStream htmlStream = new FileStream("OutputWorksheet.html", FileMode.Create);
workbook.ExportToHtml(htmlStream, worksheet.Index);

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportToHtml(Stream, Int32) 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.

C#

winforms-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/ExportActions.cs#L39

FileStream htmlStream = new FileStream("OutputWorksheet.html", FileMode.Create);
workbook.ExportToHtml(htmlStream, worksheet.Index);
htmlStream.Close();

VB.NET

wpf-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ExportActions.vb#L38

            Dim htmlStream As New FileStream("OutputWorksheet.html", FileMode.Create)
            workbook.ExportToHtml(htmlStream, worksheet.Index)
'            #End Region ' #ExportToHTML

winforms-spreadsheetcontrol-api-part-2/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/ExportActions.vb#L36

Dim htmlStream As New FileStream("OutputWorksheet.html", FileMode.Create)
workbook.ExportToHtml(htmlStream, worksheet.Index)
htmlStream.Close()