LinkBase.ExportToImage(Stream, ImageExportOptions) Method

Exports a document to the specified stream in Image format using the defined Image-specific options.

Namespace: DevExpress.XtraPrinting

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

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public void ExportToImage(
    Stream stream,
    ImageExportOptions options
)

VB.NET

Public Sub ExportToImage(
    stream As Stream,
    options As ImageExportOptions
)

Parameters

Name	Type	Description
stream	Stream	A Stream object to which the created Image file should be sent.
options	ImageExportOptions	An ImageExportOptions object which specifies the Image export options to be applied when a document is exported.

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 Image format using the specified Image export options (e.g. ImageExportOptions.Format).

For more information, see Export to Image.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToImage(Stream, ImageExportOptions) 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.

VB.NET

office-file-api-create-thumbnail-images-for-docx-xlsx-pdf-files/VB/ImageExporterHelper.vb#L46

options.PageRange = "1"
pLink.ExportToImage(mStream, options)
mStream.Position = 0