XtraReport.ExportToImage(String, ImageExportOptions) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Exports a report to the specified file in Image format.

Namespace : DevExpress.XtraReports.UI

Assembly : DevExpress.XtraReports.v25.2.dll

NuGet Package : DevExpress.Reporting.Core

csharp

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 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.

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.

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#
VB.NET

csharp

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

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