SheetRender class

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.

The SheetRender type exposes the following members:

Constructors

ConstructorDescription
__init__(self, worksheet, options)the construct of SheetRender, need worksheet and ImageOrPrintOptions as params

Properties

PropertyDescription
page_countGets the total page count of current worksheet.
page_scaleGets calculated page scale of the sheet.
Returns the set scale if PageSetup.zoom is set. Otherwise, returns the calculated scale according to PageSetup.fit_to_pages_wide and PageSetup.fit_to_pages_tall.

Methods

MethodDescription
to_image(self, page_index, file_name)Render certain page to a file.
to_image(self, page_index, stream)Render certain page to a stream.
to_tiff(self, stream)Render whole worksheet as Tiff Image to stream.
to_tiff(self, filename)Render whole worksheet as Tiff Image to a file.
to_printer(self, printer_name)Render worksheet to Printer
to_printer(self, printer_name, job_name)Render worksheet to Printer
to_printer(self, printer_settings)Render worksheet to Printer
to_printer(self, printer_settings, job_name)Render worksheet to Printer
to_printer(self, printer_name, print_page_index, print_page_count)Render worksheet to Printer
get_page_size_inch(self, page_index)Get page size in inch of output image.
custom_print(self, next_page_after_print, print_page_event_args)Client can control page setting of printer when print each page using this function.
dispose(self)Releases resources created and used for rendering.

See Also