Skip to main content

XtraReport.ExportToHtml(Stream, HtmlExportOptions) Method

Exports a report to the specified stream in HTML format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

public void ExportToHtml(
    Stream stream,
    HtmlExportOptions options = null
)

Parameters

Name Type Description
stream Stream

A Stream for output data.

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.

Note

Do not set the ImageExportOptions.ExportMode property to ImageExportMode.DifferentFiles when you use this method to export to a stream.

Use the ExportToHtmlAsync(Stream, 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.

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

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

See Also