ChartControl.ExportToImage(Stream, ImageFormat) Method

Creates an image file in the specified format from the current chart and exports it to a stream.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v18.2.UI.dll

Declaration

C#

public void ExportToImage(
    Stream stream,
    ImageFormat format
)

VB.NET

Public Sub ExportToImage(
    stream As Stream,
    format As ImageFormat
)

Parameters

Name	Type	Description
stream	Stream	A Stream object to which the current chart is exported.
format	ImageFormat	A ImageFormat value representing the format in which the chart is exported.

Remarks

Use this method to export the current chart as an image to an object of the Stream class or its descendants. The image format should be specified by the format parameter, for instance, ImageFormat.BMP. After creating an image file, the chart can be displayed in an appropriate application.

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.v18.2 assembly.

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

Example

The following example demonstrates how to use the ExportToImage method to create an image from a chart control. The first method returns the image in the specified format, while the second writes the chart’s image in the specified format to the specified path.

C#

using System.IO;
using System.Drawing;
using System.Drawing.Imaging;
using DevExpress.XtraCharts;
// ...

private Image GetChartImage(ChartControl chart, ImageFormat format) {
   // Create an image.
   Image image = null;

   // Create an image of the chart.
   using(MemoryStream s = new MemoryStream()) {
      chart.ExportToImage(s, format);
      image = Image.FromStream(s);
   }

   // Return the image.
   return image;
}

private void SaveChartImageToFile(ChartControl chart, ImageFormat format, String fileName) {
   // Create an image in the specified format from the chart
   // and save it to the specified path.
   chart.ExportToImage(fileName, format);
}

VB.NET

Imports System.IO
Imports System.Drawing
Imports System.Drawing.Imaging
Imports DevExpress.XtraCharts
' ...

Private Function GetChartImage(Chart As ChartControl, Format As ImageFormat) As Image
   ' Create an image.
   Dim Image As Image = Nothing

   ' Create an image of the chart.
   Dim s As New MemoryStream()
   Try
      Chart.ExportToImage(s, Format)
      Image = Image.FromStream(s)
   Finally
      s.Dispose()
   End Try

   ' Return the image.
   Return Image
End Function

Private Sub SaveChartImageToFile(Chart As ChartControl, Format As ImageFormat, FileName As String)
   ' Create an image in the specified format from the chart
   ' and save it to the specified path.
   Chart.ExportToImage(FileName, Format)
End Sub

Related GitHub Examples

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

C#

how-to-copy-a-chart-to-the-clipboard-e1156/CS/Form1.cs#L18

try {
    chartControl1.ExportToImage(ms, ImageFormat.Png);
    ms.Seek(0, SeekOrigin.Begin);

how-to-enhance-the-output-quality-of-a-chart-in-its-print-preview-e869/CS/Form1.cs#L16

try {
    chartControl1.ExportToImage(ms, System.Drawing.Imaging.ImageFormat.Wmf);
    ms.Seek(0, SeekOrigin.Begin);

Reporting_how-to-control-the-size-of-printable-objects-in-the-xtraprinting-library-e317/CS/Form1.cs#L31

chartControl1.ExportToImage(ms, ImageFormat.Wmf);
ms.Seek(0, SeekOrigin.Begin);

VB.NET

how-to-copy-a-chart-to-the-clipboard-e1156/VB/Form1.vb#L20

Try
    chartControl1.ExportToImage(ms, ImageFormat.Png)
    ms.Seek(0, SeekOrigin.Begin)

how-to-enhance-the-output-quality-of-a-chart-in-its-print-preview-e869/VB/Form1.vb#L18

Try
    chartControl1.ExportToImage(ms, System.Drawing.Imaging.ImageFormat.Wmf)
    ms.Seek(0, SeekOrigin.Begin)

Reporting_how-to-control-the-size-of-printable-objects-in-the-xtraprinting-library-e317/VB/Form1.vb#L30

chartControl1.ExportToImage(ms, ImageFormat.Wmf)
ms.Seek(0, SeekOrigin.Begin)