Class SheetRender
SheetRender class
Represents a worksheet render which can render worksheet to various images such as (BMP, PNG, JPEG, TIFF..) The constructor of this class , must be used after modification of pagesetup, cell style.
Constructors
| Name | Description |
|---|
| SheetRender(Worksheet, ImageOrPrintOptions) | the construct of SheetRender, need worksheet and ImageOrPrintOptions as params |
Properties
| Name | Description |
|---|
| PageCount { get; } | Gets the total page count of current worksheet. |
| PageScale { get; } | Gets calculated page scale of the sheet. Returns the set scale if Zoom is set. Otherwise, returns the calculated scale according to FitToPagesWide and FitToPagesTall. |
Methods
| Name | Description |
|---|
| CustomPrint(bool, PrintPageEventArgs) | Client can control page setting of printer when print each page using this function. |
| Dispose() | Releases resources created and used for rendering. |
| GetPageSizeInch(int) | Get page size in inch of output image. |
| ToImage(int) | Render certain page to a Bitmap object. |
| ToImage(int, Stream) | Render certain page to a stream. |
| ToImage(int, string) | Render certain page to a file. |
| ToImage(int, Graphics, float, float) | Render certain page to a Graphics |
| ToImage(int, Graphics, float, float, float, float) | Render certain page to a Graphics |
| ToPrinter(PrinterSettings) | Render worksheet to Printer |
| ToPrinter(string) | Render worksheet to Printer |
| ToPrinter(PrinterSettings, string) | Render worksheet to Printer |
| ToPrinter(string, string) | Render worksheet to Printer |
| ToPrinter(string, int, int) | (Obsolete.) Render worksheet to Printer |
| ToTiff(Stream) | Render whole worksheet as Tiff Image to stream. |
| ToTiff(string) | Render whole worksheet as Tiff Image to a file. |
Examples
using System;
using Aspose.Cells;
using Aspose.Cells.Rendering;
namespace AsposeCellsExamples
{
public class RenderingClassSheetRenderDemo
{
public static void Run()
{
Workbook wb = new Workbook();
Worksheet sheet = wb.Worksheets[0];
// Add sample data
for (int i = 0; i < 10; i++)
{
for (int j = 0; j < 5; j++)
{
sheet.Cells[i, j].PutValue($"Data {i},{j}");
}
}
// Configure page setup
PageSetup pageSetup = sheet.PageSetup;
pageSetup.PrintArea = "1:10";
pageSetup.SetFitToPages(1, 1);
// Create SheetRender and demonstrate core functionality
ImageOrPrintOptions options = new ImageOrPrintOptions();
SheetRender sr = new SheetRender(sheet, options);
Console.WriteLine($"Number of pages: {sr.PageCount}");
Console.WriteLine($"Page scale: {sr.PageScale * 100}%");
// Render first page to image (demonstration)
sr.ToImage(0, "output_page1.png");
}
}
}
See Also
