asposecells.api

Classes

Constants

Class ImageOrPrintOptions

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

Example:

# Set Image Or Print Options
options = ImageOrPrintOptions()
# set Horizontal resolution
options.setHorizontalResolution(200)
# set Vertica Resolution
options.setVerticalResolution(300)

# Instantiate Workbook
book = Workbook("Book2.xlsx")
# Save chart as Image using ImageOrPrint Options
book.getWorksheets().get(3).getCharts().get(0).toImage("chart.png", options)

Constructor Summary
`ImageOrPrintOptions()`

Property Getters/Setters Summary
`method`	`getAllColumnsInOnePagePerSheet()`
`method`	`setAllColumnsInOnePagePerSheet(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.
`method`	`getChartImageType()`
`method`	`setChartImageType(value)`
	Indicate the chart imagetype when converting. default value: PNG.
`method`	`getCheckWorkbookDefaultFont()`
`method`	`setCheckWorkbookDefaultFont(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.
`method`	`getDefaultEditLanguage()`
`method`	`setDefaultEditLanguage(value)`
	Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant.
`method`	`getDefaultFont()`
`method`	`setDefaultFont(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.
`method`	`getDrawObjectEventHandler()`
`method`	`setDrawObjectEventHandler(value)`
	Implements this interface to get DrawObject and Bound when rendering.
`method`	`getEmbededImageNameInSvg()`
`method`	`setEmbededImageNameInSvg(value)`
	Indicate the filename of embedded image in svg. This should be full path with directory like "c:\\xpsEmbedded"
`method`	`getEmfRenderSetting()`
`method`	`setEmfRenderSetting(value)`
	Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
`method`	`getGridlineType()`
`method`	`setGridlineType(value)`
	Gets or sets gridline type. The value of the property is GridlineType integer constant.
`method`	`getHorizontalResolution()`
`method`	`setHorizontalResolution(value)`
	Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.
`method`	`getImageType()`
`method`	`setImageType(value)`
	Gets or sets the format of the generated images. default value: PNG. The value of the property is ImageType integer constant.
`method`	`isCellAutoFit()`
`method`	`setCellAutoFit(value)`
	Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.
`method`	`isFontSubstitutionCharGranularity()`
`method`	`setFontSubstitutionCharGranularity(value)`
	Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
`method`	`isOptimized()`
`method`	`setOptimized(value)`
	Indicates whether to optimize the output elements.
`method`	`getOnePagePerSheet()`
`method`	`setOnePagePerSheet(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.
`method`	`getOnlyArea()`
`method`	`setOnlyArea(value)`
	If this property is true , one Area will be output, and no scale will take effect.
`method`	`getOutputBlankPageWhenNothingToPrint()`
`method`	`setOutputBlankPageWhenNothingToPrint(value)`
	Indicates whether to output a blank page when there is nothing to print.
`method`	`getPageCount()`
`method`	`setPageCount(value)`
	Gets or sets the number of pages to save.
`method`	`getPageIndex()`
`method`	`setPageIndex(value)`
	Gets or sets the 0-based index of the first page to save.
`method`	`getPageSavingCallback()`
`method`	`setPageSavingCallback(value)`
	Control/Indicate progress of page saving process.
`method`	`getPrintingPage()`
`method`	`setPrintingPage(value)`
	Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
`method`	`getPrintWithStatusDialog()`
`method`	`setPrintWithStatusDialog(value)`
	If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
`method`	`getQuality()`
`method`	`setQuality(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
`method`	`getSaveFormat()`
`method`	`setSaveFormat(value)`
	Gets or sets the output file format type Support Tiff/XPS The value of the property is SaveFormat integer constant.
`method`	`getSheetSet()`
`method`	`setSheetSet(value)`
	Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
`method`	`getSVGFitToViewPort()`
`method`	`setSVGFitToViewPort(value)`
	if this property is true, the generated svg will fit to view port.
`method`	`getTextCrossType()`
`method`	`setTextCrossType(value)`
	Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.
`method`	`getTiffColorDepth()`
`method`	`setTiffColorDepth(value)`
	Gets or sets bit depth to apply only when saving pages to the `Tiff` format. The value of the property is ColorDepth integer constant.
`method`	`getTiffCompression()`
`method`	`setTiffCompression(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.
`method`	`getTransparent()`
`method`	`setTransparent(value)`
	Indicates if the background of generated image should be transparent.
`method`	`getVerticalResolution()`
`method`	`setVerticalResolution(value)`
	Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.

Method Summary
`method`	`getTiffPhotometricInterpretation()`
`method`	Gets the type of PhotometricInterpretation to apply only when saving pages to the `Tiff` format.
`method`	`setDesiredSize(desiredWidth, desiredHeight)`
`method`	Sets desired width and height of image.
`method`	`setDesiredSize(desiredWidth, desiredHeight, keepAspectRatio)`
`method`	Sets desired width and height of image.
`method`	`setRenderingHint(key, value)`
`method`	Sets the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values.
`method`	`setTiffPhotometricInterpretation(value)`
`method`	Sets the type of PhotometricInterpretation to apply only when saving pages to the `Tiff` format.

- Constructor Detail
  - ImageOrPrintOptions
```
ImageOrPrintOptions()
```
- Property Getters/Setters Detail
  - getSaveFormat/setSaveFormat : int
```
int getSaveFormat() / setSaveFormat(value)
```
    Gets or sets the output file format type Support Tiff/XPS The value of the property is SaveFormat integer constant.
    NOTE: This member is now obsolete. Instead, For Tiff/Svg, use ImageType; For Xps, use Workbook.save(java.lang.String, com.aspose.cells.SaveOptions) with XpsSaveOptions. This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getPrintWithStatusDialog/setPrintWithStatusDialog : boolean
```
boolean getPrintWithStatusDialog() / setPrintWithStatusDialog(value)
```
    If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
  - getHorizontalResolution/setHorizontalResolution : int
```
int getHorizontalResolution() / setHorizontalResolution(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 : int
```
int getVerticalResolution() / setVerticalResolution(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 : int
```
int getTiffCompression() / setTiffCompression(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.
  - getTiffColorDepth/setTiffColorDepth : int
```
int getTiffColorDepth() / setTiffColorDepth(value)
```
    Gets or sets bit depth to apply only when saving pages to the Tiff format. The value of the property is ColorDepth integer constant.
    Has effect only when saving to TIFF. If TiffCompression is set to CCITT3, CCITT4, this will not take effect, the bit depth of the generated tiff image will be always 1.
  - getPrintingPage/setPrintingPage : int
```
int getPrintingPage() / setPrintingPage(value)
```
    Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant.
  - getQuality/setQuality : int
```
int getQuality() / setQuality(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.
  - getImageType/setImageType : int
```
int getImageType() / setImageType(value)
```
    Gets or sets the format of the generated images. default value: PNG. The value of the property is ImageType integer constant.
  - isCellAutoFit/setCellAutoFit : boolean
```
boolean isCellAutoFit() / setCellAutoFit(value)
```
    Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.
    NOTE: This member is now obsolete. Instead, please use Worksheet.autoFitColumns(com.aspose.cells.AutoFitterOptions) and Worksheet.autoFitRows(com.aspose.cells.AutoFitterOptions). This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getOnePagePerSheet/setOnePagePerSheet : boolean
```
boolean getOnePagePerSheet() / setOnePagePerSheet(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 : boolean
```
boolean getAllColumnsInOnePagePerSheet() / setAllColumnsInOnePagePerSheet(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 : DrawObjectEventHandler
```
DrawObjectEventHandler getDrawObjectEventHandler() / setDrawObjectEventHandler(value)
```
    Implements this interface to get DrawObject and Bound when rendering.
  - getChartImageType/setChartImageType : ImageFormat
```
ImageFormat getChartImageType() / setChartImageType(value)
```
    Indicate the chart imagetype when converting. default value: PNG.
    NOTE: This member is now obsolete. Instead, Chart and Shape are always rendered as vector elements(e.g. point, line) for rendering quality. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.
  - getEmbededImageNameInSvg/setEmbededImageNameInSvg : String
```
String getEmbededImageNameInSvg() / setEmbededImageNameInSvg(value)
```
    Indicate the filename of embedded image in svg. This should be full path with directory like "c:\\xpsEmbedded"
  - getSVGFitToViewPort/setSVGFitToViewPort : boolean
```
boolean getSVGFitToViewPort() / setSVGFitToViewPort(value)
```
    if this property is true, the generated svg will fit to view port.
  - getOnlyArea/setOnlyArea : boolean
```
boolean getOnlyArea() / setOnlyArea(value)
```
    If this property is true , one Area will be output, and no scale will take effect.
  - getTransparent/setTransparent : boolean
```
boolean getTransparent() / setTransparent(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.
  - getPageSavingCallback/setPageSavingCallback : IPageSavingCallback
```
IPageSavingCallback getPageSavingCallback() / setPageSavingCallback(value)
```
    Control/Indicate progress of page saving process.
  - isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity : boolean
```
boolean isFontSubstitutionCharGranularity() / setFontSubstitutionCharGranularity(value)
```
    Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
    Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
  - getPageIndex/setPageIndex : int
```
int getPageIndex() / setPageIndex(value)
```
    Gets or sets the 0-based index of the first page to save.
    Default is 0.
  - getPageCount/setPageCount : int
```
int getPageCount() / setPageCount(value)
```
    Gets or sets the number of pages to save.
    Default is System.Int32.MaxValue which means all pages will be rendered.
  - isOptimized/setOptimized : boolean
```
boolean isOptimized() / setOptimized(value)
```
    Indicates whether to optimize the output elements.
    Default value is false. Currently when this property is set to true, the following optimizations will be done: 1. optimize the border lines. 2. optimize the file size while rendering to Svg image.
  - getDefaultFont/setDefaultFont : String
```
String getDefaultFont() / setDefaultFont(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 : boolean
```
boolean getCheckWorkbookDefaultFont() / setCheckWorkbookDefaultFont(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 : boolean
```
boolean getOutputBlankPageWhenNothingToPrint() / setOutputBlankPageWhenNothingToPrint(value)
```
    Indicates whether to output a blank page when there is nothing to print.
    Default is false.
  - getGridlineType/setGridlineType : int
```
int getGridlineType() / setGridlineType(value)
```
    Gets or sets gridline type. The value of the property is GridlineType integer constant.
    Default is Dotted type.
  - getTextCrossType/setTextCrossType : int
```
int getTextCrossType() / setTextCrossType(value)
```
    Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.
  - getDefaultEditLanguage/setDefaultEditLanguage : int
```
int getDefaultEditLanguage() / setDefaultEditLanguage(value)
```
    Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant.
    It may display/render different layouts for text paragraph when different edit languages is set. Default is DefaultEditLanguage.AUTO.
  - getSheetSet/setSheetSet : SheetSet
```
SheetSet getSheetSet() / setSheetSet(value)
```
    Gets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible.
    The set is ignored when it is used in SheetRender
  - getEmfRenderSetting/setEmfRenderSetting : int
```
int getEmfRenderSetting() / setEmfRenderSetting(value)
```
    Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant.
    EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to image, otherwise only EMF records will be parsed. Default value is EmfRenderSetting.EMF_ONLY. For the frameworks that depend on .Net System.Drawing.Common, this setting is ignored.
- Method Detail
  - getTiffPhotometricInterpretation
```
int getTiffPhotometricInterpretation()
```
    Gets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format.
    Has effect only when saving to TIFF. The default value is -1, represent no PhotometricInterpretation is applied.
  - setTiffPhotometricInterpretation
```
 setTiffPhotometricInterpretation(value)
```
    Sets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format.
    Has effect only when saving to TIFF. The default value is -1, represent no PhotometricInterpretation is applied.
  - setRenderingHint
```
 setRenderingHint(key, value)
```
    Sets the value of a single preference for the rendering algorithms. Hint categories include controls for rendering quality and overall time/quality trade-off in the rendering process. Refer to the RenderingHints class for definitions of some common keys and values.
    Parameters:
    key: Key - the key of the hint to be set.
    value: Object - the value indicating preferences for the specified hint category.
  - setDesiredSize
```
 setDesiredSize(desiredWidth, desiredHeight)
```
    Sets desired width and height of image.
    NOTE: This member is now obsolete. Instead, please use setDesiredSize(int, int, boolean) by setting param keepAspectRatio to false. This property will be removed 12 months later since May 2023. Aspose apologizes for any inconvenience you may have experienced.
    Parameters:
    desiredWidth: int - desired width in pixels
    desiredHeight: int - desired height in pixels
  - setDesiredSize
```
 setDesiredSize(desiredWidth, desiredHeight, keepAspectRatio)
```
    Sets desired width and height of image.
    Parameters:
    desiredWidth: int - desired width in pixels
    desiredHeight: int - desired height in pixels
    keepAspectRatio: boolean - whether to keep aspect ratio of origin image

asposecells.api

Classes

Constants

Class ImageOrPrintOptions

Constructor Detail

ImageOrPrintOptions

Property Getters/Setters Detail

getSaveFormat/setSaveFormat : int

getPrintWithStatusDialog/setPrintWithStatusDialog : boolean

getHorizontalResolution/setHorizontalResolution : int

getVerticalResolution/setVerticalResolution : int

getTiffCompression/setTiffCompression : int

getTiffColorDepth/setTiffColorDepth : int

getPrintingPage/setPrintingPage : int

getQuality/setQuality : int

getImageType/setImageType : int

isCellAutoFit/setCellAutoFit : boolean

getOnePagePerSheet/setOnePagePerSheet : boolean

getAllColumnsInOnePagePerSheet/setAllColumnsInOnePagePerSheet : boolean

getDrawObjectEventHandler/setDrawObjectEventHandler : DrawObjectEventHandler

getChartImageType/setChartImageType : ImageFormat

getEmbededImageNameInSvg/setEmbededImageNameInSvg : String

getSVGFitToViewPort/setSVGFitToViewPort : boolean

getOnlyArea/setOnlyArea : boolean

getTransparent/setTransparent : boolean

getPageSavingCallback/setPageSavingCallback : IPageSavingCallback

isFontSubstitutionCharGranularity/setFontSubstitutionCharGranularity : boolean

getPageIndex/setPageIndex : int

getPageCount/setPageCount : int

isOptimized/setOptimized : boolean

getDefaultFont/setDefaultFont : String

getCheckWorkbookDefaultFont/setCheckWorkbookDefaultFont : boolean

getOutputBlankPageWhenNothingToPrint/setOutputBlankPageWhenNothingToPrint : boolean

getGridlineType/setGridlineType : int

getTextCrossType/setTextCrossType : int

getDefaultEditLanguage/setDefaultEditLanguage : int

getSheetSet/setSheetSet : SheetSet

getEmfRenderSetting/setEmfRenderSetting : int

Method Detail

getTiffPhotometricInterpretation

setTiffPhotometricInterpretation

setRenderingHint

setDesiredSize

setDesiredSize