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.v20.2.dll
NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Reporting.Core
Declaration
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.
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 { }
}