Previous topicNext topic
Help > 开发指南 > Excel > API > 示例 > Worksheet >
如何：从工作表生成缩略图

电子表格文档 API 允许您为工作表创建缩略图。缩略图是一个小图像，您可以将其插入到文档、演示文稿或网站中以显示工作表内容的预览。

调用 Worksheet 对象的 WorksheetExtensions.CreateThumbnail 扩展方法，以从工作表生成指定大小的缩略图。将 ImageFileFormat 枚举成员传递给此方法以设置缩略图格式。
缩略图包括以下工作表元素：

如果工作表大于缩略图，则工作表将被裁剪以适合此缩略图。如果工作表较小，则剩余空间将填充默认背景色。

下面的代码示例从工作表生成缩略图。

Vb.Net
'创建一个Workbook工作簿对象.
Using workbook As New DevExpress.Spreadsheet.Workbook()
    workbook.LoadDocument("D:\Document.xlsx", DevExpress.Spreadsheet.DocumentFormat.Xlsx)

    ' 获得当前工作表的引用
    Dim worksheet As DevExpress.Spreadsheet.Worksheet = workbook.Worksheets.ActiveWorksheet

    '创建一个缩略图
    If worksheet IsNot Nothing Then
        worksheet.CreateThumbnail("D:\Worksheet_Thumbnail.png", DevExpress.Spreadsheet.ImageFileFormat.Png, 1600, 900)
    End If
End Using

C#
// 创建一个Workbook工作簿对象.
using (DevExpress.Spreadsheet.Workbook workbook = new DevExpress.Spreadsheet.Workbook())
{
    workbook.LoadDocument(@"D:\Document.xlsx", DevExpress.Spreadsheet.DocumentFormat.Xlsx);

    // 获得当前工作表的引用
    DevExpress.Spreadsheet.Worksheet worksheet = workbook.Worksheets.ActiveWorksheet;

    // 创建一个缩略图
    if (worksheet != null)
        worksheet.CreateThumbnail(@"D:\Worksheet_Thumbnail.png", DevExpress.Spreadsheet.ImageFileFormat.Png, 1600, 900);
}

自定义缩略图设置

创建一个 WorksheetThumbnailOptions 类实例，并将其传递给 WorksheetExtensions.CreateThumbnail 方法以指定缩略图选项。可以使用以下选项：
WorksheetThumbnailOptions 属性 说明 描述
BackgroundColor 背景颜色 指定输出图像的背景色。
Resolution 分辨率 指定图像分辨率（以 DPI 为单位）。
Scale 规模 指定在将工作表内容另存为图像之前如何缩放工作表的内容。如果 Stretch 属性设置为 true，则 Scale 属性不起作用。
Stretch 伸展 指定是否拉伸工作表以适合输出图像大小。
ColumnOffset 列偏移量 指定要从中开始生成缩略图的列的索引。
RowOffset 行偏移量 指定要从中开始生成缩略图的行的索引。

下面的代码示例指定缩略图选项并生成缩略图。

Vb.Net
'创建一个Workbook工作簿对象.
Using workbook As New DevExpress.Spreadsheet.Workbook()
    workbook.LoadDocument("D:\Document.xlsx", DevExpress.Spreadsheet.DocumentFormat.Xlsx)

    ' 获得当前工作表的引用
    Dim worksheet As DevExpress.Spreadsheet.Worksheet = workbook.Worksheets.ActiveWorksheet
    '指定缩略选项.
    Dim thumbnailOptions = New DevExpress.Spreadsheet.WorksheetThumbnailOptions With {
      .Resolution = 192,
      .Scale = 80,
      .ColumnOffset = 1,
      .RowOffset = 1,
      .BackgroundColor = Color.FromArgb(&HF2, &HF2, &HF2)
    }
    '创建一个缩略图
    If worksheet IsNot Nothing Then
        worksheet.CreateThumbnail("D:\Worksheet_Thumbnail.png", DevExpress.Spreadsheet.ImageFileFormat.Png, 1600, 900,thumbnailOptions)
    End If
End Using

C#
// 创建一个Workbook工作簿对象.
using (DevExpress.Spreadsheet.Workbook workbook = new DevExpress.Spreadsheet.Workbook())
{
    workbook.LoadDocument(@"D:\Document.xlsx", DevExpress.Spreadsheet.DocumentFormat.Xlsx);

    // 获得当前工作表的引用
    DevExpress.Spreadsheet.Worksheet worksheet = workbook.Worksheets.ActiveWorksheet;

    // 指定缩略选项.
    var thumbnailOptions = new DevExpress.Spreadsheet.WorksheetThumbnailOptions()
    {
        Resolution = 192,
        Scale = 80,
        ColumnOffset = 1,
        RowOffset = 1,
        BackgroundColor = Color.FromArgb(0xF2, 0xF2, 0xF2)
    };
    // 创建一个缩略图
    if (worksheet != null)
        worksheet.CreateThumbnail(@"D:\Worksheet_Thumbnail.png", DevExpress.Spreadsheet.ImageFileFormat.Png, 1600, 900, thumbnailOptions);
}

提示

您可以使用CellRange对象的CellRangeExtensions.ExportToImage扩展方法，用于将单元格区域另存为图像。有关代码示例，请参阅以下帮助主题：如何：将单元格区域另存为图像。