LinkBase.ExportToImage(String, ImageExportOptions) Method

Exports a document to the specified file path 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(
    string filePath,
    ImageExportOptions options
)

VB.NET

Public Sub ExportToImage(
    filePath As String,
    options As ImageExportOptions
)

Parameters

Name	Type	Description
filePath	String	A String which specifies the file name (including the full path) for the created Image file.
options	ImageExportOptions	A 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 file using the specified Image export options (e.g. ImageExportOptions.Format).

Note

This method overwrites any files present at the specified path that have the same file name without any warnings.

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(String, 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.

C#

dxrichedit-for-wpf-how-to-print-a-document-as-a-series-of-images/CS/SaveAsImage/MainWindow.xaml.cs#L36

imgOptions.PageRange = "1,3-5";
pcl.ExportToImage("export.png", imgOptions);
#endregion #saveasimage

VB.NET

dxrichedit-for-wpf-how-to-print-a-document-as-a-series-of-images/VB/SaveAsImage/MainWindow.xaml.vb#L31

            imgOptions.PageRange = "1,3-5"
            pcl.ExportToImage("export.png", imgOptions)
'#End Region  ' #saveasimage