XtraReport.ExportToImage(String, ImageFormat) Method
Exports a report to the specified file in the specified image format.
Namespace: DevExpress.XtraReports.UI
Assembly: DevExpress.XtraReports.v20.2.dll
NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core
Declaration
Parameters
Name | Type | Description |
---|---|---|
path | String | The path to the exported image file. |
format | ImageFormat | The image format. |
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 an image in the specified image format.
The current report export options are in effect. To get access to the current 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.
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.
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 { }
}
Related GitHub Examples
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToImage(String, 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.