XtraReport.ExportToMht(String, MhtExportOptions) Method

Exports a report to the specified file in MHT format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

Declaration

public void ExportToMht(
    string path,
    MhtExportOptions options = null
)
Public Sub ExportToMht(
    path As String,
    options As MhtExportOptions = Nothing
)

Parameters

Name Type Description
path String

A String that is the full path to a file.

Optional Parameters

Name Type Default Description
options MhtExportOptions

null

A MhtExportOptions object that specifies the MHT 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 MHT file with the specified MHT 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.Mht property provides access to the MhtExportOptions object that contains the MHT export options.

IMPORTANT

This method overwrites files with the same name without confirmation.

Use the ExportToMhtAsync(String, MhtExportOptions, CancellationToken) method instead of ExportToMht to export a report asynchronously in a separate task.

Examples

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

The project uses the XtraReport.ExportToMht method with the MhtExportOptions object as a parameter.

NOTE

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

using System.Drawing;
using System.Diagnostics;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
// ...

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

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

    // Get its MHT export options.
    MhtExportOptions mhtOptions = report.ExportOptions.Mht;

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

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

    // Export the report to MHT.
    report.ExportToMht(reportPath);

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

// Use this method if you want to automaically open
// the created MHT file in the default program.
public void StartProcess(string path)
{
    Process process = new Process();
    try
    {
        process.StartInfo.FileName = path;
        process.Start();
        process.WaitForInputIdle();
    }
    catch { }
}
See Also