Skip to main content
All docs
V24.1
Row

ChartSheetExtensions.CreateThumbnail(ChartSheet, Int32, Int32) Method

Saves the chart sheet as an image with the specified size.

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 OfficeImage CreateThumbnail(
    this ChartSheet chartSheet,
    int width,
    int height
)

Parameters

Name Type Description
chartSheet ChartSheet

The chart sheet to be saved as an image.

width Int32

The output image width in pixels.

height Int32

The output image height in pixels.

Returns

Type Description
OfficeImage

The output image.

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 default background color.

The code sample below saves a chart sheet as an image:

Generate a Thumbnail from the Chart Sheet

using DevExpress.Spreadsheet;
// ...

// 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;

    // Save the chart sheet as an image.
    if (chartSheet != null)
        chartSheet.CreateThumbnail(920, 670).NativeImage.Save("Chart_sheet_Thumbnail.png");
}
See Also