PrintingSystemBase.ExportToImage(String, ImageFormat) Method

Exports a document to the specified file path using the specified image format.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v20.2.Core.dll

NuGet Packages: DevExpress.Printing.Core, DevExpress.WindowsDesktop.Printing.Core

Declaration

C#

public void ExportToImage(
    string filePath,
    ImageFormat format
)

VB.NET

Public Sub ExportToImage(
    filePath As String,
    format As ImageFormat
)

Parameters

Name	Type	Description
filePath	String	A String that specifies the file name (including the full path) for the created image file.
format	ImageFormat	An ImageFormat object that specifies the image format.

Remarks

Once the document export has started, it will run until the resulting document is complete and cannot be interrupted or canceled in the process.

The printing system export options passed to this method are used instead of the current PrintingSystemBase.ExportOptions.Image options. If you wish to use the current export options of a printing system, call the PrintingSystemBase.ExportToImage(Stream) method without the options parameter.

Note

This method overwrites a file with the same file name without any warnings.

Refer to the following help topic for more information: Export to Image.

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.

C#

Reporting_how-to-override-commands-in-print-preview-custom-export-e2305/CS/OverridePreviewCommands/Form1.cs#L40

// Export the document to png.
printControl.PrintingSystem.ExportToImage("C:\\Report.png", ImageFormat.Png);

VB.NET

Reporting_how-to-override-commands-in-print-preview-custom-export-e2305/VB/OverridePreviewCommands/Form1.vb#L46

' Export the document to png.
control.PrintingSystem.ExportToImage("C:\Report.png", ImageFormat.Png)