PrintingSystemBase.ExportToImage(String, DXImageFormat) Method

Exports a document to an image with the specified format and saves it to a file.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public void ExportToImage(
    string filePath,
    DXImageFormat format
)

VB.NET

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

Parameters

Name	Type	Description
filePath	String	The file name (including the full path) for the created image file.
format	DXImageFormat	An 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.