IWorkbook.ExportToHtml(String, HtmlDocumentExporterOptions) Method

Exports the document’s data to the specified file in HTML format using the specified options.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

void ExportToHtml(
    string fileName,
    HtmlDocumentExporterOptions options
)

VB.NET

Sub ExportToHtml(
    fileName As String,
    options As HtmlDocumentExporterOptions
)

Parameters

Name	Type	Description
fileName	String	A String value which contains the full path (including the file name and extension) specifying where the HTML file will be created.
options	HtmlDocumentExporterOptions	A HtmlDocumentExporterOptions instance containing required export options.

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(String, HtmlDocumentExporterOptions) 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#L35

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

VB.NET

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

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

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

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