Aspose::Cells::Rendering::IImageOrPrintOptions Class Referenceabstract

Allows to specify options when rendering worksheet to images, printing worksheet or rendering chart to image. More...

Inherits Object.

Public Member Functions

virtual Aspose::Cells::SaveFormat GetSaveFormat ()=0
 Gets the output file format type Support Tiff/XPS More...
 
virtual void SetSaveFormat (Aspose::Cells::SaveFormat value)=0
 Sets the output file format type Support Tiff/XPS More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::PrintPageEventHandler > GetCustomPrintPageEventHandler ()=0
 Client can special output to printer when print each page using this EventHandler More...
 
virtual void SetCustomPrintPageEventHandler (intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::PrintPageEventHandler > value)=0
 Client can special output to printer when print each page using this EventHandler More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::QueryPageSettingsEventHandler > GetCustomQueryPageSettingsEventHandler ()=0
 Client can control page setting of printer when print each page using this EventHandler More...
 
virtual void SetCustomQueryPageSettingsEventHandler (intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::QueryPageSettingsEventHandler > value)=0
 Client can control page setting of printer when print each page using this EventHandler More...
 
virtual bool GetPrintWithStatusDialog ()=0
 If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show. More...
 
virtual void SetPrintWithStatusDialog (bool value)=0
 If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show. More...
 
virtual Aspose::Cells::Systems::Int32 GetHorizontalResolution ()=0
 Gets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images. More...
 
virtual void SetHorizontalResolution (Aspose::Cells::Systems::Int32 value)=0
 Sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images. More...
 
virtual Aspose::Cells::Systems::Int32 GetVerticalResolution ()=0
 Gets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image. More...
 
virtual void SetVerticalResolution (Aspose::Cells::Systems::Int32 value)=0
 Sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image. More...
 
virtual Aspose::Cells::Rendering::TiffCompression GetTiffCompression ()=0
 Gets the type of compression to apply only when saving pages to the Tiff format. More...
 
virtual void SetTiffCompression (Aspose::Cells::Rendering::TiffCompression value)=0
 Sets the type of compression to apply only when saving pages to the Tiff format. More...
 
virtual Aspose::Cells::PrintingPageType GetPrintingPage ()=0
 Indicates which pages will not be printed. More...
 
virtual void SetPrintingPage (Aspose::Cells::PrintingPageType value)=0
 Indicates which pages will not be printed. More...
 
virtual Aspose::Cells::Systems::Int32 GetQuality ()=0
 Gets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100 More...
 
virtual void SetQuality (Aspose::Cells::Systems::Int32 value)=0
 Sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100 More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat > GetImageFormat ()=0
 Gets the format of the generated images. Don't apply the method that returns a Bitmap object. More...
 
virtual void SetImageFormat (intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat > value)=0
 Sets the format of the generated images. Don't apply the method that returns a Bitmap object. More...
 
virtual bool IsCellAutoFit ()=0
 Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false. More...
 
virtual void SetCellAutoFit (bool value)=0
 Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false. More...
 
virtual bool IsImageFitToPage ()=0
 When set the value to true, the page only include the cells that have data. The default value is false. More...
 
virtual void SetImageFitToPage (bool value)=0
 When set the value to true, the page only include the cells that have data. The default value is false. More...
 
virtual bool GetOnePagePerSheet ()=0
 If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect. More...
 
virtual void SetOnePagePerSheet (bool value)=0
 If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect. More...
 
virtual bool GetAllColumnsInOnePagePerSheet ()=0
 If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect. More...
 
virtual void SetAllColumnsInOnePagePerSheet (bool value)=0
 If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat > GetChartImageType ()=0
 Indicate the chart imagetype when converting. More...
 
virtual void SetChartImageType (intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat > value)=0
 Indicate the chart imagetype when converting. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetEmbededImageNameInSvg ()=0
 Indicate the filename of embeded image in svg. This should be full path with directory like "c:\\xpsEmbeded" More...
 
virtual void SetEmbededImageNameInSvg (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Indicate the filename of embeded image in svg. This should be full path with directory like "c:\\xpsEmbeded" More...
 
virtual bool GetSVGFitToViewPort ()=0
 if this property is true, the generated svg will fit to view port. More...
 
virtual void SetSVGFitToViewPort (bool value)=0
 if this property is true, the generated svg will fit to view port. More...
 
virtual bool GetOnlyArea ()=0
 If this property is true , onle Area will be output, and no scale will take effect. More...
 
virtual void SetOnlyArea (bool value)=0
 If this property is true , onle Area will be output, and no scale will take effect. More...
 
virtual Aspose::Cells::Systems::Drawing::Text::TextRenderingHint GetTextRenderingHint ()=0
 Specifies the quality of text rendering. The defaul value is TextRenderingHint.SystemDefault More...
 
virtual void SetTextRenderingHint (Aspose::Cells::Systems::Drawing::Text::TextRenderingHint value)=0
 Specifies the quality of text rendering. The defaul value is TextRenderingHint.SystemDefault More...
 
virtual Aspose::Cells::Systems::Drawing::Drawing2D::SmoothingMode GetSmoothingMode ()=0
 Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. The defaul value is SmoothingMode.None More...
 
virtual void SetSmoothingMode (Aspose::Cells::Systems::Drawing::Drawing2D::SmoothingMode value)=0
 Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. The defaul value is SmoothingMode.None More...
 
virtual bool GetTransparent ()=0
 Indicates if the background of generated image should be transparent. More...
 
virtual void SetTransparent (bool value)=0
 Indicates if the background of generated image should be transparent. More...
 
virtual Aspose::Cells::Systems::Drawing::Imaging::PixelFormat GetPixelFormat ()=0
 Gets the pixel format for the generated images. More...
 
virtual void SetPixelFormat (Aspose::Cells::Systems::Drawing::Imaging::PixelFormat value)=0
 Sets the pixel format for the generated images. More...
 
virtual void SetDesiredSize (Aspose::Cells::Systems::Int32 desiredWidth, Aspose::Cells::Systems::Int32 desiredHeight)=0
 Sets desired width and height of image. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetDefaultFont ()=0
 When characters in the Excel are unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters. More...
 
virtual void SetDefaultFont (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 When characters in the Excel are unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters. More...
 

Detailed Description

Allows to specify options when rendering worksheet to images, printing worksheet or rendering chart to image.

Member Function Documentation

◆ GetAllColumnsInOnePagePerSheet()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::GetAllColumnsInOnePagePerSheet ( )
pure virtual

If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

◆ GetChartImageType()

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Imaging::ImageFormat> Aspose::Cells::Rendering::IImageOrPrintOptions::GetChartImageType ( )
pure virtual

Indicate the chart imagetype when converting.

◆ GetCustomPrintPageEventHandler()

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Printing::PrintPageEventHandler> Aspose::Cells::Rendering::IImageOrPrintOptions::GetCustomPrintPageEventHandler ( )
pure virtual

Client can special output to printer when print each page using this EventHandler

◆ GetCustomQueryPageSettingsEventHandler()

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Printing::QueryPageSettingsEventHandler> Aspose::Cells::Rendering::IImageOrPrintOptions::GetCustomQueryPageSettingsEventHandler ( )
pure virtual

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

◆ GetDefaultFont()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Rendering::IImageOrPrintOptions::GetDefaultFont ( )
pure virtual

When characters in the Excel are unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.

◆ GetEmbededImageNameInSvg()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::Rendering::IImageOrPrintOptions::GetEmbededImageNameInSvg ( )
pure virtual

Indicate the filename of embeded image in svg. This should be full path with directory like "c:\\xpsEmbeded"

◆ GetHorizontalResolution()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Rendering::IImageOrPrintOptions::GetHorizontalResolution ( )
pure virtual

Gets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.

The default value is 96.

◆ GetImageFormat()

virtual intrusive_ptr<Aspose::Cells::Systems::Drawing::Imaging::ImageFormat> Aspose::Cells::Rendering::IImageOrPrintOptions::GetImageFormat ( )
pure virtual

Gets the format of the generated images. Don't apply the method that returns a Bitmap object.

The default value is ImageFormat.Bmp. Don't apply the method that returns a Bitmap object.

◆ GetOnePagePerSheet()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::GetOnePagePerSheet ( )
pure virtual

If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

◆ GetOnlyArea()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::GetOnlyArea ( )
pure virtual

If this property is true , onle Area will be output, and no scale will take effect.

◆ GetPixelFormat()

virtual Aspose::Cells::Systems::Drawing::Imaging::PixelFormat Aspose::Cells::Rendering::IImageOrPrintOptions::GetPixelFormat ( )
pure virtual

Gets the pixel format for the generated images.

The default value is PixelFormat.Format32bppArgb.

◆ GetPrintingPage()

virtual Aspose::Cells::PrintingPageType Aspose::Cells::Rendering::IImageOrPrintOptions::GetPrintingPage ( )
pure virtual

Indicates which pages will not be printed.

◆ GetPrintWithStatusDialog()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::GetPrintWithStatusDialog ( )
pure virtual

If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.

◆ GetQuality()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Rendering::IImageOrPrintOptions::GetQuality ( )
pure virtual

Gets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100

Has effect only when saving to JPEG. The value must be between 0 and 100. The default value is 100.

◆ GetSaveFormat()

virtual Aspose::Cells::SaveFormat Aspose::Cells::Rendering::IImageOrPrintOptions::GetSaveFormat ( )
pure virtual

Gets the output file format type Support Tiff/XPS

◆ GetSmoothingMode()

virtual Aspose::Cells::Systems::Drawing::Drawing2D::SmoothingMode Aspose::Cells::Rendering::IImageOrPrintOptions::GetSmoothingMode ( )
pure virtual

Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. The defaul value is SmoothingMode.None

◆ GetSVGFitToViewPort()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::GetSVGFitToViewPort ( )
pure virtual

if this property is true, the generated svg will fit to view port.

◆ GetTextRenderingHint()

virtual Aspose::Cells::Systems::Drawing::Text::TextRenderingHint Aspose::Cells::Rendering::IImageOrPrintOptions::GetTextRenderingHint ( )
pure virtual

Specifies the quality of text rendering. The defaul value is TextRenderingHint.SystemDefault

◆ GetTiffCompression()

virtual Aspose::Cells::Rendering::TiffCompression Aspose::Cells::Rendering::IImageOrPrintOptions::GetTiffCompression ( )
pure virtual

Gets the type of compression to apply only when saving pages to the Tiff format.

Has effect only when saving to TIFF. The default value is Lzw.

◆ GetTransparent()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::GetTransparent ( )
pure virtual

Indicates if the background of generated image should be transparent.

The default value is false. That means the background of the generated images is white.

◆ GetVerticalResolution()

virtual Aspose::Cells::Systems::Int32 Aspose::Cells::Rendering::IImageOrPrintOptions::GetVerticalResolution ( )
pure virtual

Gets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.

The default value is 96.

◆ IsCellAutoFit()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::IsCellAutoFit ( )
pure virtual

Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.

◆ IsImageFitToPage()

virtual bool Aspose::Cells::Rendering::IImageOrPrintOptions::IsImageFitToPage ( )
pure virtual

When set the value to true, the page only include the cells that have data. The default value is false.

◆ SetAllColumnsInOnePagePerSheet()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetAllColumnsInOnePagePerSheet ( bool  value)
pure virtual

If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

◆ SetCellAutoFit()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetCellAutoFit ( bool  value)
pure virtual

Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.

◆ SetChartImageType()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetChartImageType ( intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat >  value)
pure virtual

Indicate the chart imagetype when converting.

◆ SetCustomPrintPageEventHandler()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetCustomPrintPageEventHandler ( intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::PrintPageEventHandler >  value)
pure virtual

Client can special output to printer when print each page using this EventHandler

◆ SetCustomQueryPageSettingsEventHandler()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetCustomQueryPageSettingsEventHandler ( intrusive_ptr< Aspose::Cells::Systems::Drawing::Printing::QueryPageSettingsEventHandler >  value)
pure virtual

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

◆ SetDefaultFont()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetDefaultFont ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

When characters in the Excel are unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.

◆ SetDesiredSize()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetDesiredSize ( Aspose::Cells::Systems::Int32  desiredWidth,
Aspose::Cells::Systems::Int32  desiredHeight 
)
pure virtual

Sets desired width and height of image.

Parameters
desiredWidthdesired width in pixels
desiredHeightdesired height in pixels

◆ SetEmbededImageNameInSvg()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetEmbededImageNameInSvg ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Indicate the filename of embeded image in svg. This should be full path with directory like "c:\\xpsEmbeded"

◆ SetHorizontalResolution()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetHorizontalResolution ( Aspose::Cells::Systems::Int32  value)
pure virtual

Sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.

The default value is 96.

◆ SetImageFitToPage()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetImageFitToPage ( bool  value)
pure virtual

When set the value to true, the page only include the cells that have data. The default value is false.

◆ SetImageFormat()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetImageFormat ( intrusive_ptr< Aspose::Cells::Systems::Drawing::Imaging::ImageFormat >  value)
pure virtual

Sets the format of the generated images. Don't apply the method that returns a Bitmap object.

The default value is ImageFormat.Bmp. Don't apply the method that returns a Bitmap object.

◆ SetOnePagePerSheet()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetOnePagePerSheet ( bool  value)
pure virtual

If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

◆ SetOnlyArea()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetOnlyArea ( bool  value)
pure virtual

If this property is true , onle Area will be output, and no scale will take effect.

◆ SetPixelFormat()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetPixelFormat ( Aspose::Cells::Systems::Drawing::Imaging::PixelFormat  value)
pure virtual

Sets the pixel format for the generated images.

The default value is PixelFormat.Format32bppArgb.

◆ SetPrintingPage()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetPrintingPage ( Aspose::Cells::PrintingPageType  value)
pure virtual

Indicates which pages will not be printed.

◆ SetPrintWithStatusDialog()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetPrintWithStatusDialog ( bool  value)
pure virtual

If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.

◆ SetQuality()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetQuality ( Aspose::Cells::Systems::Int32  value)
pure virtual

Sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. The default value is 100

Has effect only when saving to JPEG. The value must be between 0 and 100. The default value is 100.

◆ SetSaveFormat()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetSaveFormat ( Aspose::Cells::SaveFormat  value)
pure virtual

Sets the output file format type Support Tiff/XPS

◆ SetSmoothingMode()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetSmoothingMode ( Aspose::Cells::Systems::Drawing::Drawing2D::SmoothingMode  value)
pure virtual

Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. The defaul value is SmoothingMode.None

◆ SetSVGFitToViewPort()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetSVGFitToViewPort ( bool  value)
pure virtual

if this property is true, the generated svg will fit to view port.

◆ SetTextRenderingHint()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetTextRenderingHint ( Aspose::Cells::Systems::Drawing::Text::TextRenderingHint  value)
pure virtual

Specifies the quality of text rendering. The defaul value is TextRenderingHint.SystemDefault

◆ SetTiffCompression()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetTiffCompression ( Aspose::Cells::Rendering::TiffCompression  value)
pure virtual

Sets the type of compression to apply only when saving pages to the Tiff format.

Has effect only when saving to TIFF. The default value is Lzw.

◆ SetTransparent()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetTransparent ( bool  value)
pure virtual

Indicates if the background of generated image should be transparent.

The default value is false. That means the background of the generated images is white.

◆ SetVerticalResolution()

virtual void Aspose::Cells::Rendering::IImageOrPrintOptions::SetVerticalResolution ( Aspose::Cells::Systems::Int32  value)
pure virtual

Sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.

The default value is 96.