com.aspose.cells

Class WorkbookRender

java.lang.Object

com.aspose.cells.WorkbookRender

public class WorkbookRender
extends java.lang.Object

Represents a Workbook render. The constructor of this class , must be used after modification of pagesetup, cell style.

Remarks

Constructor Summary

Constructors

Constructor and Description
WorkbookRender(Workbook workbook, ImageOrPrintOptions options) The construct of WorkbookRender

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 workbook.
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	toImage(java.io.OutputStream stream) Render whole workbook as Tiff Image to stream.
void	toImage(java.lang.String filename) Render whole workbook as Tiff Image to a file.
void	toPrinter(java.lang.String printerName) Render workbook 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 workbook to Printer

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkbookRender

public WorkbookRender(Workbook workbook,
              ImageOrPrintOptions options)

The construct of WorkbookRender

Parameters:

workbook - Indicate which workbook to be rendered.

options - ImageOrPrintOptions contains some property of output image

Method Detail

getPageCount

public int getPageCount()

Gets the total page count of workbook.

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(java.io.OutputStream stream)

Render whole workbook as Tiff Image to stream.

Parameters:

stream - the stream of the output image

toImage

public void toImage(java.lang.String filename)

Render whole workbook as Tiff Image to a file.

Parameters:

filename - the filename of the output image

toImage

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

Render certain page to a file.

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

toPrinter

public void toPrinter(java.lang.String printerName)

Render workbook 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 workbook 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 workbook 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, WorkbookRender.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.