The requested page is not available for the requested platform. You are viewing the content for Default platform.

XtraReport.ExportToHtml(String, HtmlExportOptions) Method

Exports a report to the specified file path in HTML format using the specified HTML-specific options.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

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

Parameters

Name Type Description
path String

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

options HtmlExportOptions

A HtmlExportOptions object which specifies the HTML export options to be applied when a report is exported.

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 the specified HTML export options (like HtmlExportOptionsBase.CharacterSet, HtmlExportOptionsBase.ExportMode, etc.) Note that in this instance the current report export options, which are represented by the HtmlExportOptions object returned by the ExportOptions.Html property of a report's XtraReport.ExportOptions, are ignored.

If, instead, you want to use the current export options of a report, you should call the overloaded XtraReport.ExportToHtml method without 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.

Examples

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.

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