Skip to main content
All docs
V24.1
Row

ChartSheetExtensions.CreateThumbnail(ChartSheet, Stream, ImageFileFormat, Int32, Int32, SheetThumbnailOptions) Method

Saves the chart sheet as an image in the specified format. Allows you to specify the image size and thumbnail 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.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

public static void CreateThumbnail(
    this ChartSheet chartSheet,
    Stream stream,
    ImageFileFormat format,
    int width,
    int height,
    SheetThumbnailOptions options
)

Parameters

Name Type Description
chartSheet ChartSheet

The chart sheet to be saved as an image.

stream Stream

A stream used to save the output image.

format ImageFileFormat

The output image format.

width Int32

The output image width in pixels.

height Int32

The output image height in pixels.

options SheetThumbnailOptions

An object that defines thumbnail options.

Remarks

If the chart sheet is bigger than the thumbnail, the chart sheet is cropped to fit the thumbnail. If the chart sheet is smaller, the remaining space is filled with the background color.

The code sample below specifies thumbnail options and saves a chart sheet as an image:

Generate a Thumbnail from the Chart Sheet

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

// Create a new Workbook object.
using (Workbook workbook = new Workbook())
{
    // Load a workbook from a file.
    workbook.LoadDocument("VariableCosts.xlsx", DocumentFormat.Xlsx);

    // Access an active chart sheet.
    ChartSheet chartSheet = workbook.ChartSheets.ActiveChartSheet;

    // Specify thumbnail options.
    var thumbnailOptions = new SheetThumbnailOptions
    {
        Resolution = 192,
        Scale = 40,
        BackgroundColor = Color.FromArgb(0xF2, 0xF2, 0xF2)
    };

    // Save the chart sheet as an image.
    if (chartSheet != null) 
    {
        using (FileStream stream = new FileStream("Chart_ sheet_Thumbnail.png", FileMode.Create))
        {
            chartSheet.CreateThumbnail(stream, ImageFileFormat.Png, 800, 600, thumbnailOptions);
        }
    }
}
See Also