RichEditDocumentServerExtensions.ExportToImage(Document) Method

Exports each document page to a separate image in PNG format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.Docs.v24.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static IReadOnlyList<Stream> ExportToImage(
    this Document document
)

VB.NET

<ExtensionAttribute>
Public Shared Function ExportToImage(
    document As Document
) As IReadOnlyList(Of Stream)

Parameters

Name	Type	Description
document	Document	The document currently loaded in the RichEditDocumentServer instance.

Returns

Type	Description
IReadOnlyList<Stream>	A list of stream objects. Each object contains a document page converted to a PNG image format.

Remarks

Example

The following code sample exports all document pages to images:

C#

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

using RichEditDocumentServer wordProcessor = new RichEditDocumentServer();

var streamList = wordProcessor.Document.ExportToImage();
int i = 1;
foreach (var stream in streamList) {
    var newFileName = Path.GetFileNameWithoutExtension("ExportedPage.jpeg") + i + Path.GetExtension("ExportedPage.jpeg");
    StreamToFile(stream, newFileName);
    i++;
    stream.Dispose();
}
static void StreamToFile(Stream stream, string filePath)
{
    using (var fileStream = File.Create(filePath))
    {
        stream.Seek(0, SeekOrigin.Begin);
        stream.CopyTo(fileStream);
    }
}

VB.NET

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

Imports RichEditDocumentServer wordProcessor = New RichEditDocumentServer()

wordProcessor.LoadDocument("C:\Documents\Alice.docx")
Dim streamList = wordProcessor.Document.ExportToImage()
Dim i As Integer = 1
For Each stream In streamList
  Dim newFileName = Path.GetFileNameWithoutExtension("ExportedPage.jpeg") & i & Path.GetExtension("ExportedPage.jpeg")
  StreamToFile(stream, newFileName)
  i += 1
  stream.Dispose()
Next stream

Shared Sub StreamToFile(ByVal stream As Stream, ByVal filePath As String)
  Using fileStream = File.Create(filePath)
    stream.Seek(0, SeekOrigin.Begin)
    stream.CopyTo(fileStream)
  End Using
End Sub