XtraReport.ExportToImage(Stream, ImageExportOptions) Method

Exports a report to the specified stream as an image. Use options to specify an image format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void ExportToImage(
    Stream stream,
    ImageExportOptions options = null
)

VB.NET

Public Sub ExportToImage(
    stream As Stream,
    options As ImageExportOptions = Nothing
)

Parameters

Name	Type	Description
stream	Stream	A Stream for output data.

Optional Parameters

Name	Type	Default	Description
options	ImageExportOptions	null	The Image 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 file in Image format with the specified Image export options.

If you do not specify export options, the method uses the current report export options. To access the report export options, use the XtraReport.ExportOptions.Image notation.

Note

Do not set the ImageExportOptions.ExportMode property to ImageExportMode.DifferentFiles when you use this method to export to a stream.

Use the ExportToImageAsync(Stream, ImageExportOptions, CancellationToken) method instead of ExportToImage to export a report asynchronously in a separate task.

Example

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

The project uses the XtraReport.ExportToImage method with the ImageExportOptions object as a parameter.

C#

using System.Diagnostics;
using DevExpress.Drawing;
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 = DXImageFormat.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 DevExpress.Drawing
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 = DXImageFormat.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

Related GitHub Examples

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

reporting-webforms-print-export-report-without-showing-a-preview/CS/T227361/Default.aspx.cs#L95

case "png":
    report.ExportToImage(ms, new ImageExportOptions() { Format = System.Drawing.Imaging.ImageFormat.Png });
    break;

reporting-mvc-print-export-report-without-preview/CS/T569785/Controllers/HomeController.cs#L102

case "png":
    report.ExportToImage(ms, new ImageExportOptions() { Format = System.Drawing.Imaging.ImageFormat.Png });
    break;

VB.NET

reporting-webforms-print-export-report-without-showing-a-preview/VB/T227361/Default.aspx.vb#L82

Case "png"
    report.ExportToImage(ms, New ImageExportOptions() With {.Format = System.Drawing.Imaging.ImageFormat.Png})
Case Else

reporting-mvc-print-export-report-without-preview/VB/T569785/Controllers/HomeController.vb#L86

    Case "png"
        report.ExportToImage(ms, New ImageExportOptions() With {.Format = System.Drawing.Imaging.ImageFormat.Png})
End Select