XtraReport.ExportToImage(Stream) Method

Exports a report to the specified stream in Image format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public void ExportToImage(
    Stream stream
)

VB.NET

Public Sub ExportToImage(
    stream As Stream
)

Parameters

Name	Type	Description
stream	Stream	A Stream object to which the created Image file should be sent.

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 Image format using its current Image-specific export options. These options are represented by the ImageExportOptions object returned by the ExportOptions.Image property of a report’s XtraReport.ExportOptions. This object provides the ImageExportOptions.Format and other properties which are intended to specify parameters of the resulting Image file.

If you want to ignore current export options of a report, and use your specific settings when a report is exported to Image, you should use the overloaded XtraReport.ExportToImage method with the options parameter.

Note

For more information on using the ExportToImage method, and limitations on export to Image, please refer to the Export to Image document.

Example

The following example demonstrates how to export a report to image. To do this, the XtraReport.ExportToImage method should be used. It also demonstrates what specific ImageExportOptions may be used when a report is exported to image.

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 *.png files in your system, you can call the StartProcess method, which is also shown in this example.

Tip

Online Example: How to export a report to image

C#

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

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

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

    // Get its Image export options.
    ImageExportOptions imageOptions = report.ExportOptions.Image;

    // Set Image-specific export options.
    imageOptions.Format = ImageFormat.Png;

    // Export the report to Image.
    report.ExportToImage(reportPath);

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

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

VB.NET

Imports System.Diagnostics
Imports System.Drawing.Imaging
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
' ...

Private Sub ExportToPNG()
    ' A path to export a report.
    Dim reportPath As String = "c:\\Test.png"

    ' Create a report instance.
    Dim report As New XtraReport1()

    ' Get its Image export options.
    Dim imageOptions As ImageExportOptions = report.ExportOptions.Image

    ' Set Image-specific export options.
    imageOptions.Format = ImageFormat.Png

    ' Export the report to Image.
    report.ExportToImage(reportPath)

    ' Show the result.
    StartProcess(reportPath)
End Sub

' Use this method if you want to automaically open
' the created Image file in the default program.
Public Sub StartProcess(ByVal path As String)
    Dim process As New Process()
    Try
        process.StartInfo.FileName = path
        process.Start()
        process.WaitForInputIdle()
    Catch
    End Try
End Sub