com.aspose.cells

Class ImageOrPrintOptions

  • java.lang.Object
    • com.aspose.cells.ImageOrPrintOptions
public class ImageOrPrintOptions 
extends java.lang.Object

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

Example:

//Set Image Or Print Options
ImageOrPrintOptions options = new ImageOrPrintOptions();

//set Horizontal resolution
options.setHorizontalResolution(200);

//set Vertica; Resolution
options.setVerticalResolution(300);

//Instantiate Workbook
Workbook book = new Workbook("c:\\test.xls");

//Save chart as Image using ImageOrPrint Options
Bitmap chartObject = book.getWorksheets().get(0).getCharts().get(0).toImage(options);

Constructor Summary
 
Property Getters/Setters Summary
booleangetAllColumnsInOnePagePerSheet()
void
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.
ImageFormatgetChartImageType()
void
Indicate the chart imagetype when converting.
booleangetCheckWorkbookDefaultFont()
void
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 this to true to try to use workbook's default font to show these characters first.
java.lang.StringgetDefaultFont()
void
setDefaultFont(java.lang.Stringvalue)
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.
DrawObjectEventHandlergetDrawObjectEventHandler()
void
Implements this interface to get DrawObject and Bound when rendering.
java.lang.StringgetEmbededImageNameInSvg()
void
setEmbededImageNameInSvg(java.lang.Stringvalue)
Indicate the filename of embeded image in svg. This should be full path with directory like "c:\\xpsEmbeded"
intgetHorizontalResolution()
void
Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.
ImageFormatgetImageFormat()
void
Gets or sets the format of the generated images. Don't apply the method that returns a Bitmap object.
booleanisCellAutoFit()
void
setCellAutoFit(booleanvalue)
Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.
booleanisImageFitToPage()
void
setImageFitToPage(booleanvalue)
When set the value to true, the page only include the cells that have data. The default value is false.
booleangetOnePagePerSheet()
void
setOnePagePerSheet(booleanvalue)
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.
booleangetOnlyArea()
void
setOnlyArea(booleanvalue)
If this property is true , onle Area will be output, and no scale will take effect.
booleangetOutputBlankPageWhenNothingToPrint()
void
Indicates whether to output a blank page when there is nothing to print.
intgetPrintingPage()
void
setPrintingPage(intvalue)
Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
booleangetPrintWithStatusDialog()
void
If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
intgetQuality()
void
setQuality(intvalue)
Gets or 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
intgetSaveFormat()
void
setSaveFormat(intvalue)
Gets or sets the output file format type Support Tiff/XPS The value of the property is SaveFormat integer constant.
booleangetSVGFitToViewPort()
void
setSVGFitToViewPort(booleanvalue)
if this property is true, the generated svg will fit to view port.
intgetTiffCompression()
void
Gets or sets the type of compression to apply only when saving pages to the Tiff format. The value of the property is TiffCompression integer constant.
booleangetTransparent()
void
setTransparent(booleanvalue)
Indicates if the background of generated image should be transparent.
intgetVerticalResolution()
void
Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.
IWarningCallbackgetWarningCallback()
void
Gets or sets warning callback.
 
Method Summary
voidsetDesiredSize(intdesiredWidth, intdesiredHeight)
Sets desired width and height of image.
 

    • Constructor Detail

      • ImageOrPrintOptions

        public ImageOrPrintOptions()
    • Property Getters/Setters Detail

      • getSaveFormat/setSaveFormat

        public int getSaveFormat() / public void setSaveFormat(int value)
        
        Gets or sets the output file format type Support Tiff/XPS The value of the property is SaveFormat integer constant.
      • getPrintWithStatusDialog/setPrintWithStatusDialog

        public boolean getPrintWithStatusDialog() / public void setPrintWithStatusDialog(boolean value)
        
        If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
      • getHorizontalResolution/setHorizontalResolution

        public int getHorizontalResolution() / public void setHorizontalResolution(int value)
        
        Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images. The default value is 96.
      • getVerticalResolution/setVerticalResolution

        public int getVerticalResolution() / public void setVerticalResolution(int value)
        
        Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image. The default value is 96.
      • getTiffCompression/setTiffCompression

        public int getTiffCompression() / public void setTiffCompression(int value)
        
        Gets or sets the type of compression to apply only when saving pages to the Tiff format. The value of the property is TiffCompression integer constant. Has effect only when saving to TIFF. The default value is Lzw.
      • getPrintingPage/setPrintingPage

        public int getPrintingPage() / public void setPrintingPage(int value)
        
        Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
      • getQuality/setQuality

        public int getQuality() / public void setQuality(int value)
        
        Gets or 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.
      • getImageFormat/setImageFormat

        public ImageFormat getImageFormat() / public void setImageFormat(ImageFormat value)
        
        Gets or 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.
      • isCellAutoFit/setCellAutoFit

        public boolean isCellAutoFit() / public void setCellAutoFit(boolean value)
        
        Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.
      • isImageFitToPage/setImageFitToPage

        public boolean isImageFitToPage() / public void setImageFitToPage(boolean value)
        
        When set the value to true, the page only include the cells that have data. The default value is false.
      • getOnePagePerSheet/setOnePagePerSheet

        public boolean getOnePagePerSheet() / public void setOnePagePerSheet(boolean value)
        
        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.
      • getAllColumnsInOnePagePerSheet/setAllColumnsInOnePagePerSheet

        public boolean getAllColumnsInOnePagePerSheet() / public void setAllColumnsInOnePagePerSheet(boolean value)
        
        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.
      • getDrawObjectEventHandler/setDrawObjectEventHandler

        public DrawObjectEventHandler getDrawObjectEventHandler() / public void setDrawObjectEventHandler(DrawObjectEventHandler value)
        
        Implements this interface to get DrawObject and Bound when rendering.
      • getChartImageType/setChartImageType

        public ImageFormat getChartImageType() / public void setChartImageType(ImageFormat value)
        
        Indicate the chart imagetype when converting.
      • getEmbededImageNameInSvg/setEmbededImageNameInSvg

        public java.lang.String getEmbededImageNameInSvg() / public void setEmbededImageNameInSvg(java.lang.String value)
        
        Indicate the filename of embeded image in svg. This should be full path with directory like "c:\\xpsEmbeded"
      • getSVGFitToViewPort/setSVGFitToViewPort

        public boolean getSVGFitToViewPort() / public void setSVGFitToViewPort(boolean value)
        
        if this property is true, the generated svg will fit to view port.
      • getOnlyArea/setOnlyArea

        public boolean getOnlyArea() / public void setOnlyArea(boolean value)
        
        If this property is true , onle Area will be output, and no scale will take effect.
      • getTransparent/setTransparent

        public boolean getTransparent() / public void setTransparent(boolean value)
        
        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.
      • getWarningCallback/setWarningCallback

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        
        Gets or sets warning callback.
      • getDefaultFont/setDefaultFont

        public java.lang.String getDefaultFont() / public void setDefaultFont(java.lang.String value)
        
        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.
      • getCheckWorkbookDefaultFont/setCheckWorkbookDefaultFont

        public boolean getCheckWorkbookDefaultFont() / public void setCheckWorkbookDefaultFont(boolean value)
        
        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 this to true to try to use workbook's default font to show these characters first. Default is true.
      • getOutputBlankPageWhenNothingToPrint/setOutputBlankPageWhenNothingToPrint

        public boolean getOutputBlankPageWhenNothingToPrint() / public void setOutputBlankPageWhenNothingToPrint(boolean value)
        
        Indicates whether to output a blank page when there is nothing to print. Default is false.
    • Method Detail

      • setDesiredSize

        public void setDesiredSize(int desiredWidth, int desiredHeight)
        Sets desired width and height of image.
        Parameters:
        desiredWidth - desired width in pixels
        desiredHeight - desired height in pixels