XtraReport.ExportToImage(String, ImageExportOptions) Method

Exports a report to the specified file in Image format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

Declaration

public void ExportToImage(
    string path,
    ImageExportOptions options = null
)
Public Sub ExportToImage(
    path As String,
    options As ImageExportOptions = Nothing
)

Parameters

Name Type Description
path String

The path to the exported image file.

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 Image file with the specified Image 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.Image property provides access to the ImageExportOptions object that contains the Image export options.

IMPORTANT

This method overwrites files with the same name without confirmation.

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

Examples

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.

NOTE

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

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 { }
}
See Also