Aspose::Cells::Rendering::ISheetRender Class Referenceabstract

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.
More...

Inherits Object.

Public Member Functions

virtual Aspose::Cells::Systems::Int32 GetPageCount ()=0
 Indicate the total page count of current worksheet More...
 
virtual void SetPageCount (Aspose::Cells::Systems::Int32 value)=0
 Indicate the total page count of current worksheet More...
 
virtual Aspose::Cells::Systems::Double GetPageScale ()=0
 Gets calculated page scale of the sheet. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Size > GetPageSize (Aspose::Cells::Systems::Int32 pageIndex)=0
 Get page size of output image. The size unit is in pixel. More...
 
virtual void ToImage (Aspose::Cells::Systems::Int32 pageIndex, intrusive_ptr< Aspose::Cells::Systems::Drawing::Graphics > g, Aspose::Cells::Systems::Single x, Aspose::Cells::Systems::Single y, Aspose::Cells::Systems::Single width, Aspose::Cells::Systems::Single height)=0
 Render certain page to a Graphics More...
 
virtual void ToImage (Aspose::Cells::Systems::Int32 pageIndex, intrusive_ptr< Aspose::Cells::Systems::Drawing::Graphics > g, Aspose::Cells::Systems::Single x, Aspose::Cells::Systems::Single y)=0
 Render certain page to a Graphics More...
 
virtual void ToImage (Aspose::Cells::Systems::Int32 pageIndex, intrusive_ptr< Aspose::Cells::Systems::String > fileName)=0
 Render certain page to a file. More...
 
virtual void ToImage (Aspose::Cells::Systems::Int32 pageIndex, intrusive_ptr< Aspose::Cells::Systems::IO::Stream > stream)=0
 Render certain page to a stream. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Bitmap > ToImage (Aspose::Cells::Systems::Int32 pageIndex)=0
 Render certain page to a Bitmap object. More...
 
virtual void ToTiff (intrusive_ptr< Aspose::Cells::Systems::IO::Stream > stream)=0
 Render whole worksheet as Tiff Image to stream. More...
 
virtual void ToTiff (intrusive_ptr< Aspose::Cells::Systems::String > filename)=0
 Render whole worksheet as Tiff Image to a file. More...
 
virtual void ToPrinter (intrusive_ptr< Aspose::Cells::Systems::String > PrinterName)=0
 Render worksheet to Printer More...
 
virtual void ToPrinter (intrusive_ptr< Aspose::Cells::Systems::String > PrinterName, Aspose::Cells::Systems::Int32 PrintPageIndex, Aspose::Cells::Systems::Int32 PrintPageCount)=0
 Render worksheet to Printer More...
 
virtual void ToPrinter (intrusive_ptr< Aspose::Cells::Systems::String > PrinterName, intrusive_ptr< Aspose::Cells::Systems::String > DocumentName)=0
 Render worksheet to Printer More...
 
virtual Aspose::Cells::Systems::Int32 CustomPrint (bool nextPageAfterPrint, intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::PrintPageEventArgs > printPageEventArgs)=0
 Client can control page setting of printer when print each page using this function. More...
 

Detailed Description

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.

Member Function Documentation

◆ CustomPrint()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Rendering::ISheetRender::CustomPrint ( bool  nextPageAfterPrint,
intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::PrintPageEventArgs >  printPageEventArgs 
)
pure virtual

Client can control page setting of printer when print each page using this function.

Parameters
nextPageAfterPrintIf true , printer will go to next page after print current page
printPageEventArgsSystem.Drawing.Printing.PrintPageEventArgs
Returns
Indirect next page index, based on zero

◆ GetPageCount()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Rendering::ISheetRender::GetPageCount ( )
pure virtual

Indicate the total page count of current worksheet

◆ GetPageScale()

virtual Aspose::Cells::Systems::Double Aspose::Cells::Rendering::ISheetRender::GetPageScale ( )
pure virtual

Gets calculated page scale of the sheet.

Returns

◆ GetPageSize()

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Size> Aspose::Cells::Rendering::ISheetRender::GetPageSize ( Aspose::Cells::Systems::Int32  pageIndex)
pure virtual

Get page size of output image. The size unit is in pixel.

Parameters
pageIndexThe page index is based on zero.
Returns

◆ SetPageCount()

virtual void Aspose::Cells::Rendering::ISheetRender::SetPageCount ( Aspose::Cells::Systems::Int32  value)
pure virtual

Indicate the total page count of current worksheet

◆ ToImage() [1/5]

virtual void Aspose::Cells::Rendering::ISheetRender::ToImage ( Aspose::Cells::Systems::Int32  pageIndex,
intrusive_ptr< Aspose::Cells::Systems::Drawing::Graphics >  g,
Aspose::Cells::Systems::Single  x,
Aspose::Cells::Systems::Single  y,
Aspose::Cells::Systems::Single  width,
Aspose::Cells::Systems::Single  height 
)
pure virtual

Render certain page to a Graphics

Parameters
pageIndexindicate which page is to be converted
gThe object where to render to.
xThe X coordinate (in pixels) of the top left corner of the rendered page.
yThe Y coordinate (in pixels) of the top left corner of the rendered page.
widthThe maximum width (in pixels) that can be occupied by the rendered page.
heightThe maximum height (in pixels) that can be occupied by the rendered page.

◆ ToImage() [2/5]

virtual void Aspose::Cells::Rendering::ISheetRender::ToImage ( Aspose::Cells::Systems::Int32  pageIndex,
intrusive_ptr< Aspose::Cells::Systems::Drawing::Graphics >  g,
Aspose::Cells::Systems::Single  x,
Aspose::Cells::Systems::Single  y 
)
pure virtual

Render certain page to a Graphics

Parameters
pageIndexindicate which page is to be converted
gThe object where to render to.
xThe X coordinate (in pixels) of the top left corner of the rendered page.
yThe Y coordinate (in pixels) of the top left corner of the rendered page.

◆ ToImage() [3/5]

virtual void Aspose::Cells::Rendering::ISheetRender::ToImage ( Aspose::Cells::Systems::Int32  pageIndex,
intrusive_ptr< Aspose::Cells::Systems::String >  fileName 
)
pure virtual

Render certain page to a file.

Parameters
pageIndexindicate which page is to be converted
fileNamefilename of the output image

◆ ToImage() [4/5]

virtual void Aspose::Cells::Rendering::ISheetRender::ToImage ( Aspose::Cells::Systems::Int32  pageIndex,
intrusive_ptr< Aspose::Cells::Systems::IO::Stream >  stream 
)
pure virtual

Render certain page to a stream.

Parameters
pageIndexindicate which page is to be converted
streamthe stream of the output image

◆ ToImage() [5/5]

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Bitmap> Aspose::Cells::Rendering::ISheetRender::ToImage ( Aspose::Cells::Systems::Int32  pageIndex)
pure virtual

Render certain page to a Bitmap object.

Parameters
pageIndexindicate which page is to be converted
Returns
the bitmap object of the page

◆ ToPrinter() [1/3]

virtual void Aspose::Cells::Rendering::ISheetRender::ToPrinter ( intrusive_ptr< Aspose::Cells::Systems::String >  PrinterName)
pure virtual

Render worksheet to Printer

Parameters
PrinterNamethe name of the printer , for example: "Microsoft Office Document Image Writer"

◆ ToPrinter() [2/3]

virtual void Aspose::Cells::Rendering::ISheetRender::ToPrinter ( intrusive_ptr< Aspose::Cells::Systems::String >  PrinterName,
Aspose::Cells::Systems::Int32  PrintPageIndex,
Aspose::Cells::Systems::Int32  PrintPageCount 
)
pure virtual

Render worksheet to Printer

Parameters
PrinterNamethe name of the printer , for example: "Microsoft Office Document Image Writer"
PrintPageIndexthe 0-based index of the first page to print, it must be in Range [0, SheetRender.PageCount-1]
PrintPageCountthe number of pages to print, it must be greater than zero

◆ ToPrinter() [3/3]

virtual void Aspose::Cells::Rendering::ISheetRender::ToPrinter ( intrusive_ptr< Aspose::Cells::Systems::String >  PrinterName,
intrusive_ptr< Aspose::Cells::Systems::String >  DocumentName 
)
pure virtual

Render worksheet to Printer

Parameters
PrinterNamethe name of the printer , for example: "Microsoft Office Document Image Writer"
DocumentNameset the print job name

◆ ToTiff() [1/2]

virtual void Aspose::Cells::Rendering::ISheetRender::ToTiff ( intrusive_ptr< Aspose::Cells::Systems::IO::Stream >  stream)
pure virtual

Render whole worksheet as Tiff Image to stream.

Parameters
streamthe stream of the output image

◆ ToTiff() [2/2]

virtual void Aspose::Cells::Rendering::ISheetRender::ToTiff ( intrusive_ptr< Aspose::Cells::Systems::String >  filename)
pure virtual

Render whole worksheet as Tiff Image to a file.

Parameters
filenamethe filename of the output image