CellRangeExtensions.ExportToImage(CellRange, Stream, ImageFileFormat, RangeImageOptions) Method

Exports the cell range to an image in the specified format and allows you to specify export options.

You need a license for the DevExpress Office File API Subscription or DevExpress Universal Subscription to use this method in production code.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v24.2.dll

NuGet Package: DevExpress.Document.Processor

Declaration

C#

public static void ExportToImage(
    this CellRange range,
    Stream stream,
    ImageFileFormat format,
    RangeImageOptions options
)

VB.NET

<ExtensionAttribute>
Public Shared Sub ExportToImage(
    range As CellRange,
    stream As Stream,
    format As ImageFileFormat,
    options As RangeImageOptions
)

Parameters

Name	Type	Description
range	CellRange	The cell range to be exported to an image.
stream	Stream	A stream used to save the output image.
format	ImageFileFormat	The output image format.
options	RangeImageOptions	An object that defines export options.

Exceptions

Type	Description
InvalidOperationException	Occurs when you call this method for a union range that consists of non-adjacent cell ranges.

Remarks

The following example demonstrates how to export a cell range to an image:

C#

using DevExpress.Spreadsheet;
using System.Drawing;
using System.IO;
// ...

var exportOptions = new RangeImageOptions
{
    Resolution = 192,
    ExportHeadings = true,
    ExportGridlines = true,
    GridlineColor = Color.Gray,
    BackgroundColor = Color.FromArgb(0xF2, 0xF2, 0xF2)
};
using (FileStream imageStream = new FileStream("RangeImage.png", FileMode.Create))
{
    worksheet.Range["B1:I25"].ExportToImage(imageStream, ImageFileFormat.Png, exportOptions);
}

VB.NET

Imports DevExpress.Spreadsheet
Imports System.Drawing
Imports System.IO
' ...

Dim exportOptions As New RangeImageOptions With {
    .Resolution = 192,
    .ExportHeadings = True,
    .ExportGridlines = True,
    .GridlineColor = Color.Gray,
    .BackgroundColor = Color.FromArgb(&HF2, &HF2, &HF2)
}
Using imageStream As New FileStream("RangeImage.png", FileMode.Create)
    worksheet.Range("B1:I25").ExportToImage(imageStream, ImageFileFormat.Png, exportOptions)
End Using