ChartControl.ExportToHtml(String, HtmlExportOptions) Method

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

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.UI.dll

NuGet Package: DevExpress.Win.Charts

Declaration

C#

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

VB.NET

Public Sub ExportToHtml(
    filePath As String,
    options As HtmlExportOptions = Nothing
)

Parameters

Name	Type	Description
filePath	String	A String which specifies the full path (including the file name and extension) to where the HTML file will be created.

Optional Parameters

Name	Type	Default	Description
options	HtmlExportOptions	null	A HtmlExportOptions object which specifies the HTML export options to be applied when a chart is exported.

Remarks

If a file under the specified file path exists, the new file replaces it.

To show the standard Print dialog, use the ChartControl.Print method. The dialog allows end-users to print the chart, select the printer (if required), specify the range of pages to print, the number of copies, etc.

To display the DevExpress Print Preview use one of the following methods.

Method	Description
ChartControl.ShowPrintPreview	Creates the print document and displays the Print Preview of the document.
ChartControl.ShowRibbonPrintPreview	Creates the print document and displays the Print Preview with the Ribbon toolbar of the document.

To export the chart, use the appropriate ExportTo~ method (e.g., ChartControl.ExportToHtml, ChartControl.ExportToPdf, etc.)

Important

Note that, exporting to raster and vector images is implemented by the Chart and does not require any library.

The chart can be previewed, printed and exported to other formats only if the Printing library is available. Make sure you add a reference to the DevExpress.XtraPrinting.v24.1 assembly.

Also note that chart export to PDF requires the DevExpress.Pdf.Core library to be available.

Example

The following example demonstrates how to export a chart to HTML and MHT files. You may use similar methods in your applications to export a ChartControl as HTML of MHT.

C#

using System.IO;
using DevExpress.XtraCharts;
using DevExpress.XtraPrinting;
// ...

private void ExportChartToHTML(ChartControl chart) {
    if (chart.IsPrintingAvailable) {
        // Create an object containing HTML export options.
        HtmlExportOptions htmlOptions = new HtmlExportOptions();

        // Set HTML-specific export options.
        htmlOptions.CharacterSet = "utf-8";
        htmlOptions.RemoveSecondarySymbols = false;
        htmlOptions.Title = "Unicode UTF-8 Example";

        // Export a chart to an HTML file.
        chart.ExportToHtml("OutputUnicode.html", htmlOptions);

        // Export a chart to a stream as HTML.
        using (FileStream htmlStream = new FileStream("OutputDefault.html", FileMode.Create)){
            chart.ExportToHtml(htmlStream, htmlOptions);
        }
    }
}


private void ExportChartToMHT(ChartControl chart) {
    if (chart.IsPrintingAvailable) {
        // Create an object containing MHT export options.
        MhtExportOptions mhtOptions = new MhtExportOptions();

        // Set MHT-specific export options.
        mhtOptions.CharacterSet = "iso-8859-1";
        mhtOptions.Title = "Unicode UTF-8 Example";

        // Export a chart to an MHT file.
        chart.ExportToMht("OutputUnicode.mht", mhtOptions);

        // Export a chart to a stream as MHT.
        using (FileStream mhtStream = new FileStream("OutputDefault.mht", FileMode.Create)){
            chart.ExportToMht(mhtStream, mhtOptions);
        }
    }
}

VB.NET

Imports System.IO
Imports DevExpress.XtraCharts
Imports DevExpress.XtraPrinting
' ...
Private Sub ExportChartToHTML(ByVal chart As ChartControl)
    If chart.IsPrintingAvailable Then
        ' Create an object containing HTML export options.
        Dim htmlOptions As HtmlExportOptions = New HtmlExportOptions()

        ' Set HTML-specific export options.
        htmlOptions.CharacterSet = "utf-8"
        htmlOptions.RemoveSecondarySymbols = False
        htmlOptions.Title = "Unicode UTF-8 Example"

        ' Export a chart to an HTML file.
        chart.ExportToHtml("OutputUnicode.html", htmlOptions)

        ' Export a chart to a stream as HTML.
        Using htmlStream As FileStream = New FileStream("OutputDefault.html", FileMode.Create)
            chart.ExportToHtml(htmlStream, htmlOptions)
        End Using
    End If
End Sub

Private Sub ExportChartToMHT(ByVal chart As ChartControl)
    If chart.IsPrintingAvailable Then
        ' Create an object containing MHT export options.
        Dim mhtOptions As MhtExportOptions = New MhtExportOptions()

        ' Set MHT-specific export options.
        mhtOptions.CharacterSet = "iso-8859-1"
        mhtOptions.Title = "Unicode UTF-8 Example"

        ' Export a chart to an MHT file.
        chart.ExportToMht("OutputUnicode.mht", mhtOptions)

        ' Export a chart to a stream as MHT.
        Using mhtStream As FileStream = New FileStream("OutputDefault.mht", FileMode.Create)
            chart.ExportToMht(mhtStream, mhtOptions)
        End Using
    End If
End Sub