XtraReport.ExportToHtml(String, HtmlExportOptions) Method

Exports a report to the specified file in HTML format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

Declaration

public void ExportToHtml(
    string path,
    HtmlExportOptions options = null
)
Public Sub ExportToHtml(
    path As String,
    options As HtmlExportOptions = Nothing
)

Parameters

Name Type Description
path String

The path to the exported HTML file.

Optional Parameters

Name Type Default Description
options HtmlExportOptions

null

The HTML export options. You can omit this parameter to use the current report export options.

Remarks

NOTE

Once the document export has started, it runs to completion and you cannot interrupt or cancel it.

This method exports a report to a HTML file with the specified HTML export options.

If the export options are not specified, the current report export options are used. To access the report export options, use the the report's XtraReport.ExportOptions property. The property contains the ExportOptions object whose ExportOptions.Html property provides access to the HtmlExportOptions object that contains the HTML export options.

IMPORTANT

This method overwrites files with the same name without confirmation.

Use the ExportToHtmlAsync(String, HtmlExportOptions, CancellationToken) method instead of ExportToHtml to export a report asynchronously in a separate task.

Examples

This example demonstrates how to export a report to HTML format.

The project uses the XtraReport.ExportToHtml method with the HtmlExportOptions object as a parameter.

NOTE

The complete sample project How to export a report to HTML format is available in the DevExpress Examples repository.

using System;
using System.Diagnostics;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraPrinting;
// ...

private void ExportToHTML() {
    // A path to export a report.
    string reportPath = "c:\\Test.html";

    // Create a report instance.
    XtraReport1 report = new XtraReport1();

    // Get its HTML export options.
    HtmlExportOptions htmlOptions = report.ExportOptions.Html;

    // Set HTML-specific export options.
    htmlOptions.CharacterSet = "UTF-8";
    htmlOptions.TableLayout = false;
    htmlOptions.RemoveSecondarySymbols = false;
    htmlOptions.Title = "Test Title";

    // Set the pages to be exported, and page-by-page options.
    htmlOptions.ExportMode = HtmlExportMode.SingleFilePageByPage;
    htmlOptions.PageRange = "1, 3-5";
    htmlOptions.PageBorderColor = Color.Blue;
    htmlOptions.PageBorderWidth = 3;

    // Export the report to HTML.
    report.ExportToHtml(reportPath);

    // Show the result.
    StartProcess(reportPath);
}

// Call this method to automatically open the 
// created HTML file in the system's default program.
public void StartProcess(string path) {
    Process process = new Process();
    try {
        process.StartInfo.FileName = path;
        process.Start();
        process.WaitForInputIdle();
    }
    catch { }
}
See Also