XtraReport.ExportToHtml(String) Method

Exports a report to the specified file path in HTML format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void ExportToHtml(
    string path
)

VB.NET

Public Sub ExportToHtml(
    path As String
)

Parameters

Name	Type	Description
path	String	A String which specifies the file name (including the full path) for the created HTML file.

Remarks

Once the document export has started, it will run until the resulting document is complete and cannot be interrupted or canceled in the process.

Use this method to export a report to an HTML file using its current HTML-specific export options. These options are represented by the HtmlExportOptions object returned by the ExportOptions.Html property of a report’s XtraReport.ExportOptions. This object provides the HtmlExportOptionsBase.CharacterSet, HtmlExportOptionsBase.ExportMode, HtmlExportOptionsBase.RemoveSecondarySymbols and other properties which are intended to specify parameters of the resulting HTML file.

If you want to ignore current export options of a report, and use your specific settings when a report is exported to HTML, you should use the overloaded XtraReport.ExportToHtml method with the options parameter.

Note

This method overwrites any files present at the specified path that have the same file name without any warnings.

Note

For more information on using the ExportToHtml method, and limitations on export to HTML, please refer to the Export to HTML document.

Example

This example illustrates how to export a report to HTML using the XtraReport.ExportToHtml method, as well as how to use HtmlExportOptions to adjust the options of the resulting HTML file.

For this example to work, you first need to add a new report (named XtraReport1) to your project, drop some report controls onto it, and then execute the code below (for instance, in the Button.Click event handler of any button on a form). Note also, that if you want the resulting file to be automatically opened in the default program which is used to open *.htm files in your system, you can call the StartProcess method, which is also shown in this example.

Tip

Online Example: How to export a report to HTML format

C#

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 { }
}

VB.NET

Imports System
Imports System.Drawing
Imports System.Diagnostics
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
' ...

Private Sub ExportToHTML()
    ' A path to export a report.
    Dim reportPath As String = "c:\\Test.html"

    ' Create a report instance.
    Dim report As New XtraReport1()

    ' Get its HTML export options.
    Dim htmlOptions As HtmlExportOptions = 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)
End Sub

' Call this method to automatically open the 
' created HTML file in the system's default program.
Public Sub StartProcess(ByVal path As String)
    Dim process As New Process()
    Try
        process.StartInfo.FileName = path
        process.Start()
        process.WaitForInputIdle()
    Catch
    End Try
End Sub

Related GitHub Examples

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

Reporting_report-building-basics-e925/CS/Form1.cs#L44

    // Export the report to HTML.
    report.ExportToHtml("report.html");
}

Reporting_how-to-customize-control-content-on-export-to-html-e89/CS/XRControl_HtmlItemCreated/Form1.cs#L16

XtraReport1 report = new XtraReport1();
report.ExportToHtml("Test.html");
StartProcess("Test.html");

VB.NET

Reporting_report-building-basics-e925/VB/Form1.vb#L46

    ' Export the report to HTML.
    report.ExportToHtml("report.html")
End Sub

Reporting_how-to-customize-control-content-on-export-to-html-e89/VB/XRControl_HtmlItemCreated/Form1.vb#L17

Dim report As New XtraReport1()
report.ExportToHtml("Test.html")
StartProcess("Test.html")