A newer version of this page is available. Switch to the current version.

PrintingSystemBase.ExportToImage(Stream, ImageFormat) Method

Exports a document to the specified stream in the specified Image format.

Namespace: DevExpress.XtraPrinting

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

Declaration

public virtual void ExportToImage(
    Stream stream,
    ImageFormat format
)
Public Overridable Sub ExportToImage(
    stream As Stream,
    format As ImageFormat
)

Parameters

Name Type Description
stream Stream

A Stream object to which the created Image file should be sent.

format ImageFormat

A ImageFormat object which 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.

Use this method to export a document to an image using the specified image format.

Note that in this instance the current printing system export options, which are represented by the ImageExportOptions object returned by the ExportOptions.Image property of a printing system's PrintingSystemBase.ExportOptions, are ignored.

If you want to use the current export options of a printing system, you should call the overloaded PrintingSystemBase.ExportToImage method without the format parameter.

For more information, see Export to Image.

See Also