com.aspose.cells

Class SheetRender

java.lang.Object

com.aspose.cells.SheetRender

public class SheetRender
extends java.lang.Object

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.

Constructor Summary

Constructors

Constructor and Description
SheetRender(Worksheet worksheet, ImageOrPrintOptions options) the construct of SheetRender, need worksheet and ImageOrPrintOptions as params

Method Summary

Methods

Modifier and Type	Method and Description
void	dispose() Releases resources created and used for rendering.
int	getPageCount() Gets the total page count of current worksheet.
double	getPageScale() Gets calculated page scale of the sheet.
float[]	getPageSizeInch(int pageIndex) Get page size in inch of output image.
void	toImage(int pageIndex, java.io.InputStream stream) Render certain page to a stream.
void	toImage(int pageIndex, java.io.OutputStream stream) Render certain page to a stream.
void	toImage(int pageIndex, java.lang.String fileName) Render certain page to a file.
void	toPrinter(java.lang.String printerName) Render worksheet to Printer
void	toPrinter(java.lang.String printerName, int printPageIndex, int printPageCount) Deprecated. Use ToPrinter(string PrinterName) and ImageOrPrintOptions.PageIndex, PageCount instead.
void	toPrinter(java.lang.String printerName, java.lang.String jobName) Render worksheet to Printer
void	toTiff(java.io.InputStream stream) Render whole worksheet as Tiff Image to stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SheetRender

public SheetRender(Worksheet worksheet,
           ImageOrPrintOptions options)

the construct of SheetRender, need worksheet and ImageOrPrintOptions as params

Parameters:

worksheet - Indicate which spreadsheet to be rendered.

options - ImageOrPrintOptions contains some property of output image

Method Detail

getPageCount

public int getPageCount()

Gets the total page count of current worksheet.

getPageScale

public double getPageScale()

Gets calculated page scale of the sheet. Returns the set scale if PageSetup.getZoom() is set. Otherwise, returns the calculated scale according to PageSetup.getFitToPagesWide() and PageSetup.getFitToPagesTall().

Example

 
         Workbook wb = new Workbook("Book1.xlsx");
 
         SheetRender sheetRender = new SheetRender(wb.getWorksheets().get(0), new ImageOrPrintOptions());
 
         //Gets calculated page scale of the sheet.
         double pageScale = sheetRender.getPageScale();
 

getPageSizeInch

public float[] getPageSizeInch(int pageIndex)

Get page size in inch of output image.

Parameters:

pageIndex - The page index is based on zero.

Returns:

Page size of image, [0] for width and [1] for height

toImage

public void toImage(int pageIndex,
           java.lang.String fileName)

Render certain page to a file.

Example

The following code outputs the first page of the first sheet to png image.

 
         //load the source file with images.
         Workbook wb = new Workbook("Book1.xlsx");
 
         ImageOrPrintOptions imgOpt = new ImageOrPrintOptions();
 
         //set output image type.
         imgOpt.setImageType(ImageType.PNG);
 
         //render the first sheet.
         SheetRender sr = new SheetRender(wb.getWorksheets().get(0), imgOpt);
 
         //output the first page of the sheet to image.
         sr.toImage(0, "output.png");
 

Parameters:

pageIndex - indicate which page is to be converted

fileName - filename of the output image

toImage

public void toImage(int pageIndex,
           java.io.InputStream stream)

Render certain page to a stream.

Parameters:

pageIndex - indicate which page is to be converted

stream - the stream of the output image

toImage

public void toImage(int pageIndex,
           java.io.OutputStream stream)

Render certain page to a stream.

Parameters:

pageIndex - indicate which page is to be converted

stream - the stream of the output image

toTiff

public void toTiff(java.io.InputStream stream)

Render whole worksheet as Tiff Image to stream.

Parameters:

stream - the stream of the output image

toPrinter

public void toPrinter(java.lang.String printerName)

Render worksheet to Printer

Parameters:

printerName - the name of the printer , for example: "Microsoft Office Document Image Writer"

toPrinter

public void toPrinter(java.lang.String printerName,
             java.lang.String jobName)

Render worksheet to Printer

Parameters:

printerName - the name of the printer , for example: "Microsoft Office Document Image Writer"

jobName - set the print job name

toPrinter

public void toPrinter(java.lang.String printerName,
             int printPageIndex,
             int printPageCount)

Deprecated. Use ToPrinter(string PrinterName) and ImageOrPrintOptions.PageIndex, PageCount instead.

Render worksheet to Printer

Remarks

NOTE: This method is now obsolete. Instead, please use ToPrinter(string PrinterName) and ImageOrPrintOptions.PageIndex, PageCount to set the first page and the number of pages to print. This property will be removed 12 months later since December 2021. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

printerName - the name of the printer , for example: "Microsoft Office Document Image Writer"

printPageIndex - the 0-based index of the first page to print, it must be in Range [0, SheetRender.PageCount-1]

printPageCount - the number of pages to print, it must be greater than zero

dispose

public void dispose()

Releases resources created and used for rendering.