RichEditDocumentServerExtensions.ExportToImage(Document, String, RichEditImageExportOptions) Method

SECURITY-RELATED CONSIDERATIONS

Using file paths sourced from untrusted input may expose unauthorized files or allow unintended file access. Always validate and normalize all external paths to prevent path manipulation.

Exports all document pages to images. Allows you to specify image export options.

Namespace : DevExpress.XtraRichEdit

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

csharp

public static void ExportToImage(
    this Document document,
    string path,
    RichEditImageExportOptions options
)

<ExtensionAttribute>
Public Shared Sub ExportToImage(
    document As Document,
    path As String,
    options As RichEditImageExportOptions
)

Parameters

Name	Type	Description
document	Document

The document currently loaded in the RichEditDocumentServer instance.

| | path | String |

The file name (including the full path and extension) for the created images.

| | options | RichEditImageExportOptions |

An object that contains image export options.

Example

The following code snippet exports the first document page to an image with the specified edge length and JPEG format:

C#
VB.NET

csharp

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.Export.Image;
using DevExpress.Drawing;

using (var wordProcessor = new RichEditDocumentServer()) {
    wordProcessor.LoadDocument(@"C:\Documents\Alice.docx");

    RichEditImageExportOptions options = new RichEditImageExportOptions();
    options.Format = DXImageFormat.Jpeg;
    options.PageRange = "1";
    options.LargestEdgeLength = 1080;

    wordProcessor.Document.ExportToImage(@"C:\Documents\Image.jpeg", options);
}

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.Export.Image
Imports DevExpress.Drawing

Using wordProcessor = New RichEditDocumentServer()
    wordProcessor.LoadDocument("C:\Documents\Alice.docx")

    Dim options As New RichEditImageExportOptions()
    options.Format = DXImageFormat.Jpeg
    options.PageRange = "1"
    options.LargestEdgeLength = 1080

    wordProcessor.Document.ExportToImage("C:\Documents\Image.jpeg", options)
End Using