ImageOrPrintOptions
Inheritance: java.lang.Object
public class ImageOrPrintOptions
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 output image format
options.setImageType(ImageType.PNG);
//Set Horizontal resolution
options.setHorizontalResolution(300);
//Set Vertical Resolution
options.setVerticalResolution(300);
//Instantiate Workbook
Workbook book = new Workbook("test.xls");
//Save chart as Image using ImageOrPrint Options
book.getWorksheets().get(0).getCharts().get(0).toImage("chart.png", options);
Constructors
Constructor | Description |
---|---|
ImageOrPrintOptions() |
Methods
Method | Description |
---|---|
equals(Object arg0) | |
getAllColumnsInOnePagePerSheet() | If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. |
getChartImageType() | Indicate the chart imagetype when converting. |
getCheckWorkbookDefaultFont() | 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. |
getClass() | |
getDefaultEditLanguage() | Gets default edit language. |
getDefaultFont() | 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. |
getDrawObjectEventHandler() | Implements this interface to get DrawObject and Bound when rendering. |
getEmbededImageNameInSvg() | Indicate the filename of embedded image in svg. |
getEmfRenderSetting() | Setting for rendering Emf metafile. |
getGridlineType() | Gets gridline type. |
getHorizontalResolution() | Gets the horizontal resolution for generated images, in dots per inch. |
getImageType() | Gets the format of the generated images. |
getOnePagePerSheet() | If OnePagePerSheet is true , all content of one sheet will output to only one page in result. |
getOnlyArea() | If this property is true , one Area will be output, and no scale will take effect. |
getOutputBlankPageWhenNothingToPrint() | Indicates whether to output a blank page when there is nothing to print. |
getPageCount() | Gets the number of pages to save. |
getPageIndex() | Gets the 0-based index of the first page to save. |
getPageSavingCallback() | Control/Indicate progress of page saving process. |
getPrintWithStatusDialog() | If PrintWithStatusDialog = true , there will be a dialog that shows current print status. |
getPrintingPage() | Indicates which pages will not be printed. |
getQuality() | Gets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. |
getSVGFitToViewPort() | if this property is true, the generated svg will fit to view port. |
getSaveFormat() | Gets the output file format type Support Tiff/XPS |
getSheetSet() | Gets the sheets to render. |
getTextCrossType() | Gets displaying text type when the text width is larger than cell width. |
getTiffColorDepth() | Gets bit depth to apply only when saving pages to the Tiff format. |
getTiffCompression() | Gets the type of compression to apply only when saving pages to the Tiff format. |
getTiffPhotometricInterpretation() | Gets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format. |
getTransparent() | Indicates if the background of generated image should be transparent. |
getVerticalResolution() | Gets the vertical resolution for generated images, in dots per inch. |
getWarningCallback() | Gets warning callback. |
hashCode() | |
isCellAutoFit() | Indicates whether the width and height of the cells is automatically fitted by cell value. |
isFontSubstitutionCharGranularity() | Indicates whether to only substitute the font of character when the cell font is not compatibility for it. |
isOptimized() | Indicates whether to optimize the output elements. |
notify() | |
notifyAll() | |
setAllColumnsInOnePagePerSheet(boolean value) | If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. |
setCellAutoFit(boolean value) | Indicates whether the width and height of the cells is automatically fitted by cell value. |
setChartImageType(ImageFormat value) | Indicate the chart imagetype when converting. |
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. |
setDefaultEditLanguage(int value) | Sets default edit language. |
setDefaultFont(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. |
setDesiredSize(int desiredWidth, int desiredHeight) | Sets desired width and height of image. |
setDesiredSize(int desiredWidth, int desiredHeight, boolean keepAspectRatio) | Sets desired width and height of image. |
setDrawObjectEventHandler(DrawObjectEventHandler value) | Implements this interface to get DrawObject and Bound when rendering. |
setEmbededImageNameInSvg(String value) | Indicate the filename of embedded image in svg. |
setEmfRenderSetting(int value) | Setting for rendering Emf metafile. |
setFontSubstitutionCharGranularity(boolean value) | Indicates whether to only substitute the font of character when the cell font is not compatibility for it. |
setGridlineType(int value) | Sets gridline type. |
setHorizontalResolution(int value) | Sets the horizontal resolution for generated images, in dots per inch. |
setImageType(int value) | Sets the format of the generated images. |
setOnePagePerSheet(boolean value) | If OnePagePerSheet is true , all content of one sheet will output to only one page in result. |
setOnlyArea(boolean value) | If this property is true , one Area will be output, and no scale will take effect. |
setOptimized(boolean value) | Indicates whether to optimize the output elements. |
setOutputBlankPageWhenNothingToPrint(boolean value) | Indicates whether to output a blank page when there is nothing to print. |
setPageCount(int value) | Sets the number of pages to save. |
setPageIndex(int value) | Sets the 0-based index of the first page to save. |
setPageSavingCallback(IPageSavingCallback value) | Control/Indicate progress of page saving process. |
setPrintWithStatusDialog(boolean value) | If PrintWithStatusDialog = true , there will be a dialog that shows current print status. |
setPrintingPage(int value) | Indicates which pages will not be printed. |
setQuality(int value) | Sets a value determining the quality of the generated images to apply only when saving pages to the Jpeg format. |
setRenderingHint(RenderingHints.Key key, Object value) | Sets the value of a single preference for the rendering algorithms. |
setSVGFitToViewPort(boolean value) | if this property is true, the generated svg will fit to view port. |
setSaveFormat(int value) | Sets the output file format type Support Tiff/XPS |
setSheetSet(SheetSet value) | Sets the sheets to render. |
setTextCrossType(int value) | Sets displaying text type when the text width is larger than cell width. |
setTiffColorDepth(int value) | Sets bit depth to apply only when saving pages to the Tiff format. |
setTiffCompression(int value) | Sets the type of compression to apply only when saving pages to the Tiff format. |
setTiffPhotometricInterpretation(int value) | Sets the type of PhotometricInterpretation to apply only when saving pages to the Tiff format. |
setTransparent(boolean value) | Indicates if the background of generated image should be transparent. |
setVerticalResolution(int value) | Sets the vertical resolution for generated images, in dots per inch. |
setWarningCallback(IWarningCallback value) | Sets warning callback. |
toString() | |
wait() | |
wait(long arg0) | |
wait(long arg0, int arg1) |
ImageOrPrintOptions()
public ImageOrPrintOptions()
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
Parameter | Type | Description |
---|---|---|
arg0 | java.lang.Object |
Returns: boolean
getAllColumnsInOnePagePerSheet()
public boolean getAllColumnsInOnePagePerSheet()
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.
Returns: boolean
getChartImageType()
public ImageFormat getChartImageType()
Indicate the chart imagetype when converting. default value: PNG.
Remarks
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.
Returns: ImageFormat
getCheckWorkbookDefaultFont()
public boolean getCheckWorkbookDefaultFont()
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.
Remarks
Default is true.
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getDefaultEditLanguage()
public int getDefaultEditLanguage()
Gets default edit language.
See DefaultEditLanguage.
Remarks
It may display/render different layouts for text paragraph when different edit languages is set. Default is DefaultEditLanguage.AUTO.
Returns: int
getDefaultFont()
public String getDefaultFont()
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.
Returns: java.lang.String
getDrawObjectEventHandler()
public DrawObjectEventHandler getDrawObjectEventHandler()
Implements this interface to get DrawObject and Bound when rendering.
Returns: DrawObjectEventHandler
getEmbededImageNameInSvg()
public String getEmbededImageNameInSvg()
Indicate the filename of embedded image in svg. This should be full path with directory like “c:\\xpsEmbedded”
Returns: java.lang.String
getEmfRenderSetting()
public int getEmfRenderSetting()
Setting for rendering Emf metafile.
See EmfRenderSetting.
Remarks
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.
Returns: int
getGridlineType()
public int getGridlineType()
Gets gridline type.
See GridlineType.
Remarks
Default is Dotted type.
Returns: int
getHorizontalResolution()
public int getHorizontalResolution()
Gets the horizontal resolution for generated images, in dots per inch.
Remarks
The default value is 96. Setting and effects the width and height of the output image in pixels.
Example
The following code sets resolution to 192, the width and height of the generated image is twice of the one with resolution left as the default value 96.
Workbook wb = new Workbook("Book1.xlsx");
ImageOrPrintOptions opts = new ImageOrPrintOptions();
//Set output image type: png.
opts.setImageType(ImageType.PNG);
//Set resolution to 192.
opts.setHorizontalResolution(192);
opts.setVerticalResolution(192);
//Render worksheet page to image.
SheetRender sr = new SheetRender(wb.getWorksheets().get(0), opts);
sr.toImage(0, "Sheet_Page1.png");
Returns: int
getImageType()
public int getImageType()
Gets the format of the generated images. default value: PNG.
See getImageType().
Returns: int
getOnePagePerSheet()
public boolean getOnePagePerSheet()
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.
Returns: boolean
getOnlyArea()
public boolean getOnlyArea()
If this property is true , one Area will be output, and no scale will take effect.
Returns: boolean
getOutputBlankPageWhenNothingToPrint()
public boolean getOutputBlankPageWhenNothingToPrint()
Indicates whether to output a blank page when there is nothing to print.
Remarks
Default is false.
Returns: boolean
getPageCount()
public int getPageCount()
Gets the number of pages to save.
Remarks
Default is System.Int32.MaxValue which means all pages will be rendered.
Returns: int
getPageIndex()
public int getPageIndex()
Gets the 0-based index of the first page to save.
Remarks
Default is 0.
Returns: int
getPageSavingCallback()
public IPageSavingCallback getPageSavingCallback()
Control/Indicate progress of page saving process.
Returns: IPageSavingCallback
getPrintWithStatusDialog()
public boolean getPrintWithStatusDialog()
If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
Returns: boolean
getPrintingPage()
public int getPrintingPage()
Indicates which pages will not be printed.
See PrintingPageType.
Returns: int
getQuality()
public int getQuality()
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
Remarks
Has effect only when saving to JPEG. The value must be between 0 and 100. The default value is 100.
Returns: int
getSVGFitToViewPort()
public boolean getSVGFitToViewPort()
if this property is true, the generated svg will fit to view port.
Returns: boolean
getSaveFormat()
public int getSaveFormat()
Gets the output file format type Support Tiff/XPS
See SaveFormat.
Remarks
NOTE: This member is now obsolete. Instead, For Tiff/Svg, use getImageType(); For Xps, use Workbook.save(String,SaveOptions) with XpsSaveOptions. This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.
Returns: int
getSheetSet()
public SheetSet getSheetSet()
Gets the sheets to render. Default is all visible sheets in the workbook: SheetSet.getVisible().
Remarks
The set is ignored when it is used in SheetRender
Returns: SheetSet
getTextCrossType()
public int getTextCrossType()
Gets displaying text type when the text width is larger than cell width.
See TextCrossType.
Returns: int
getTiffColorDepth()
public int getTiffColorDepth()
Gets bit depth to apply only when saving pages to the Tiff
format.
See ColorDepth.
Remarks
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.
Returns: int
getTiffCompression()
public int getTiffCompression()
Gets the type of compression to apply only when saving pages to the Tiff
format.
See TiffCompression.
Remarks
Has effect only when saving to TIFF. The default value is Lzw.
Returns: int
getTiffPhotometricInterpretation()
public int getTiffPhotometricInterpretation()
Gets the type of PhotometricInterpretation to apply only when saving pages to the Tiff
format.
Remarks
Has effect only when saving to TIFF. The default value is -1, represent no PhotometricInterpretation is applied.
Returns: int
getTransparent()
public boolean getTransparent()
Indicates if the background of generated image should be transparent.
Remarks
The default value is false. That means the background of the generated images is white.
Returns: boolean
getVerticalResolution()
public int getVerticalResolution()
Gets the vertical resolution for generated images, in dots per inch.
Remarks
The default value is 96. Setting and effects the width and height of the output image in pixels.
Example
The following code sets resolution to 192, the width and height of the generated image is twice of the one with resolution left as the default value 96.
Workbook wb = new Workbook("Book1.xlsx");
ImageOrPrintOptions opts = new ImageOrPrintOptions();
//Set output image type: png.
opts.setImageType(ImageType.PNG);
//Set resolution to 192.
opts.setHorizontalResolution(192);
opts.setVerticalResolution(192);
//Render Chart to image.
wb.getWorksheets().get(0).getCharts().get(0).toImage("Chart.png", opts);
Returns: int
getWarningCallback()
public IWarningCallback getWarningCallback()
Gets warning callback.
Returns: IWarningCallback
hashCode()
public native int hashCode()
Returns: int
isCellAutoFit()
public boolean isCellAutoFit()
Indicates whether the width and height of the cells is automatically fitted by cell value. The default value is false.
Remarks
NOTE: This member is now obsolete. Instead, please use Worksheet.autoFitColumns(AutoFitterOptions) and Worksheet.autoFitRows(AutoFitterOptions). This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.
Returns: boolean
isFontSubstitutionCharGranularity()
public boolean isFontSubstitutionCharGranularity()
Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
Remarks
Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
Returns: boolean
isOptimized()
public boolean isOptimized()
Indicates whether to optimize the output elements.
Remarks
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.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAllColumnsInOnePagePerSheet(boolean value)
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setCellAutoFit(boolean value)
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.
Remarks
NOTE: This member is now obsolete. Instead, please use Worksheet.autoFitColumns(AutoFitterOptions) and Worksheet.autoFitRows(AutoFitterOptions). This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setChartImageType(ImageFormat value)
public void setChartImageType(ImageFormat value)
Indicate the chart imagetype when converting. default value: PNG.
Remarks
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | ImageFormat |
setCheckWorkbookDefaultFont(boolean value)
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.
Remarks
Default is true.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setDefaultEditLanguage(int value)
public void setDefaultEditLanguage(int value)
Sets default edit language.
See DefaultEditLanguage.
Remarks
It may display/render different layouts for text paragraph when different edit languages is set. Default is DefaultEditLanguage.AUTO.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setDefaultFont(String value)
public void setDefaultFont(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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
setDesiredSize(int desiredWidth, int desiredHeight)
public void setDesiredSize(int desiredWidth, int desiredHeight)
Sets desired width and height of image.
Remarks
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:
Parameter | Type | Description |
---|---|---|
desiredWidth | int | desired width in pixels |
desiredHeight | int | desired height in pixels |
setDesiredSize(int desiredWidth, int desiredHeight, boolean keepAspectRatio)
public void setDesiredSize(int desiredWidth, int desiredHeight, boolean keepAspectRatio)
Sets desired width and height of image.
Remarks
The width and height of the output image in pixels will be only based on the set desired width and height. The and will not effect the width and height of the output image in this case.
Parameters:
Parameter | Type | Description |
---|---|---|
desiredWidth | int | desired width in pixels |
desiredHeight | int | desired height in pixels |
keepAspectRatio | boolean | whether to keep aspect ratio of origin image |
setDrawObjectEventHandler(DrawObjectEventHandler value)
public void setDrawObjectEventHandler(DrawObjectEventHandler value)
Implements this interface to get DrawObject and Bound when rendering.
Parameters:
Parameter | Type | Description |
---|---|---|
value | DrawObjectEventHandler |
setEmbededImageNameInSvg(String value)
public void setEmbededImageNameInSvg(String value)
Indicate the filename of embedded image in svg. This should be full path with directory like “c:\\xpsEmbedded”
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
setEmfRenderSetting(int value)
public void setEmfRenderSetting(int value)
Setting for rendering Emf metafile.
See EmfRenderSetting.
Remarks
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setFontSubstitutionCharGranularity(boolean value)
public void setFontSubstitutionCharGranularity(boolean value)
Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
Remarks
Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setGridlineType(int value)
public void setGridlineType(int value)
Sets gridline type.
See GridlineType.
Remarks
Default is Dotted type.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setHorizontalResolution(int value)
public void setHorizontalResolution(int value)
Sets the horizontal resolution for generated images, in dots per inch.
Remarks
The default value is 96. Setting and effects the width and height of the output image in pixels.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setImageType(int value)
public void setImageType(int value)
Sets the format of the generated images. default value: PNG.
See getImageType().
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setOnePagePerSheet(boolean value)
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setOnlyArea(boolean value)
public void setOnlyArea(boolean value)
If this property is true , one Area will be output, and no scale will take effect.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setOptimized(boolean value)
public void setOptimized(boolean value)
Indicates whether to optimize the output elements.
Remarks
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setOutputBlankPageWhenNothingToPrint(boolean value)
public void setOutputBlankPageWhenNothingToPrint(boolean value)
Indicates whether to output a blank page when there is nothing to print.
Remarks
Default is false.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setPageCount(int value)
public void setPageCount(int value)
Sets the number of pages to save.
Remarks
Default is System.Int32.MaxValue which means all pages will be rendered.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setPageIndex(int value)
public void setPageIndex(int value)
Sets the 0-based index of the first page to save.
Remarks
Default is 0.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setPageSavingCallback(IPageSavingCallback value)
public void setPageSavingCallback(IPageSavingCallback value)
Control/Indicate progress of page saving process.
Parameters:
Parameter | Type | Description |
---|---|---|
value | IPageSavingCallback |
setPrintWithStatusDialog(boolean value)
public void setPrintWithStatusDialog(boolean value)
If PrintWithStatusDialog = true , there will be a dialog that shows current print status. else no such dialog will show.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setPrintingPage(int value)
public void setPrintingPage(int value)
Indicates which pages will not be printed.
See PrintingPageType.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setQuality(int value)
public void setQuality(int value)
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
Remarks
Has effect only when saving to JPEG. The value must be between 0 and 100. The default value is 100.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setRenderingHint(RenderingHints.Key key, Object value)
public void setRenderingHint(RenderingHints.Key key, Object 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:
Parameter | Type | Description |
---|---|---|
key | java.awt.RenderingHints.Key | the key of the hint to be set. |
value | java.lang.Object | the value indicating preferences for the specified hint category. |
setSVGFitToViewPort(boolean value)
public void setSVGFitToViewPort(boolean value)
if this property is true, the generated svg will fit to view port.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setSaveFormat(int value)
public void setSaveFormat(int value)
Sets the output file format type Support Tiff/XPS
See SaveFormat.
Remarks
NOTE: This member is now obsolete. Instead, For Tiff/Svg, use getImageType(); For Xps, use Workbook.save(String,SaveOptions) with XpsSaveOptions. This property will be removed 12 months later since August 2022. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setSheetSet(SheetSet value)
public void setSheetSet(SheetSet value)
Sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.getVisible().
Remarks
The set is ignored when it is used in SheetRender
Parameters:
Parameter | Type | Description |
---|---|---|
value | SheetSet |
setTextCrossType(int value)
public void setTextCrossType(int value)
Sets displaying text type when the text width is larger than cell width.
See TextCrossType.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setTiffColorDepth(int value)
public void setTiffColorDepth(int value)
Sets bit depth to apply only when saving pages to the Tiff
format.
See ColorDepth.
Remarks
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.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setTiffCompression(int value)
public void setTiffCompression(int value)
Sets the type of compression to apply only when saving pages to the Tiff
format.
See TiffCompression.
Remarks
Has effect only when saving to TIFF. The default value is Lzw.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setTiffPhotometricInterpretation(int value)
public void setTiffPhotometricInterpretation(int value)
Sets the type of PhotometricInterpretation to apply only when saving pages to the Tiff
format.
Remarks
Has effect only when saving to TIFF. The default value is -1, represent no PhotometricInterpretation is applied.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setTransparent(boolean value)
public void setTransparent(boolean value)
Indicates if the background of generated image should be transparent.
Remarks
The default value is false. That means the background of the generated images is white.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
setVerticalResolution(int value)
public void setVerticalResolution(int value)
Sets the vertical resolution for generated images, in dots per inch.
Remarks
The default value is 96. Setting and effects the width and height of the output image in pixels.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
setWarningCallback(IWarningCallback value)
public void setWarningCallback(IWarningCallback value)
Sets warning callback.
Parameters:
Parameter | Type | Description |
---|---|---|
value | IWarningCallback |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
Parameter | Type | Description |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
Parameter | Type | Description |
---|---|---|
arg0 | long | |
arg1 | int |