XtraReport.ExportToHtml(String, HtmlExportOptions) Method

Exports a report to the specified file in HTML format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void ExportToHtml(
    string path,
    HtmlExportOptions options = null
)

VB.NET

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 file in HTML format with the specified HTML export options.

If you do not specify export options, the method uses the current report export options. To access the report export options, use the XtraReport.ExportOptions.Html notation.

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.

Example

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.

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