ImageSaveOptions (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.SaveOptions
- - com.aspose.words.FixedPageSaveOptions
  - - com.aspose.words.ImageSaveOptions

All Implemented Interfaces:

java.lang.Cloneable
```
public class ImageSaveOptions
extends FixedPageSaveOptions
implements java.lang.Cloneable
```
Allows to specify additional options when rendering document pages or shapes to images.
To learn more, visit the Specify Save Options documentation article.

Constructor Summary

Constructors
Constructor and Description

ImageSaveOptions(int saveFormat)
Initializes a new instance of this class.

Constructors
Constructor and Description
`ImageSaveOptions(int saveFormat)` Initializes a new instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImageSaveOptions`	`deepClone()` Creates a deep clone of this object.
`GraphicsQualityOptions`	`getGraphicsQualityOptions()` Allows to specify rendering mode and quality for the `Graphics2D` object.
`float`	`getHorizontalResolution()` Gets the horizontal resolution for the generated images, in dots per inch.
`float`	`getImageBrightness()` Gets the brightness for the generated images.
`int`	`getImageColorMode()` Gets the color mode for the generated images.
`float`	`getImageContrast()` Gets the contrast for the generated images.
`int`	`getJpegQuality()` Gets a value determining the quality of the generated JPEG images.
`MetafileRenderingOptions`	`getMetafileRenderingOptions()` Allows to specify how metafiles are treated in the rendered output.
`PageSet`	`getPageSet()` Gets the pages to render.
`java.awt.Color`	`getPaperColor()` Gets the background (paper) color for the generated images.
`int`	`getPixelFormat()` Gets the pixel format for the generated images.
`int`	`getSaveFormat()` Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used.
`float`	`getScale()` Gets the zoom factor for the generated images.
`byte`	`getThresholdForFloydSteinbergDithering()` Gets the threshold that determines the value of the binarization error in the Floyd-Steinberg method.
`int`	`getTiffBinarizationMethod()` Gets method used while converting images to 1 bpp format when `getSaveFormat()` / `setSaveFormat(int)` is SaveFormat.Tiff and `getTiffCompression()` / `setTiffCompression(int)` is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4.
`int`	`getTiffCompression()` Gets the type of compression to apply when saving generated images to the TIFF format.
`boolean`	`getUseGdiEmfRenderer()` Gets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
`float`	`getVerticalResolution()` Gets the vertical resolution for the generated images, in dots per inch.
`protected java.lang.Object`	`memberwiseClone()`
`void`	`setGraphicsQualityOptions(GraphicsQualityOptions value)` Allows to specify rendering mode and quality for the `Graphics2D` object.
`void`	`setHorizontalResolution(float value)` Sets the horizontal resolution for the generated images, in dots per inch.
`void`	`setImageBrightness(float value)` Sets the brightness for the generated images.
`void`	`setImageColorMode(int value)` Sets the color mode for the generated images.
`void`	`setImageContrast(float value)` Sets the contrast for the generated images.
`void`	`setJpegQuality(int value)` Sets a value determining the quality of the generated JPEG images.
`void`	`setPageSet(PageSet value)` Sets the pages to render.
`void`	`setPaperColor(java.awt.Color value)` Sets the background (paper) color for the generated images.
`void`	`setPixelFormat(int value)` Sets the pixel format for the generated images.
`void`	`setResolution(float value)` Sets both horizontal and vertical resolution for the generated images, in dots per inch.
`void`	`setSaveFormat(int value)` Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used.
`void`	`setScale(float value)` Sets the zoom factor for the generated images.
`void`	`setThresholdForFloydSteinbergDithering(byte value)` Sets the threshold that determines the value of the binarization error in the Floyd-Steinberg method.
`void`	`setTiffBinarizationMethod(int value)` Sets method used while converting images to 1 bpp format when `getSaveFormat()` / `setSaveFormat(int)` is SaveFormat.Tiff and `getTiffCompression()` / `setTiffCompression(int)` is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4.
`void`	`setTiffCompression(int value)` Sets the type of compression to apply when saving generated images to the TIFF format.
`void`	`setUseGdiEmfRenderer(boolean value)` Sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
`void`	`setVerticalResolution(float value)` Sets the vertical resolution for the generated images, in dots per inch.

Methods inherited from class com.aspose.words.FixedPageSaveOptions
equals, getColorMode, getNumeralFormat, getOptimizeOutput, getPageSavingCallback, setColorMode, setMetafileRenderingOptions, setNumeralFormat, setOptimizeOutput, setPageSavingCallback

Methods inherited from class com.aspose.words.SaveOptions
createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImageSaveOptions
```
public ImageSaveOptions(int saveFormat)
```
    Initializes a new instance of this class.
- Method Detail
  - getSaveFormat
```
public int getSaveFormat()
```
    Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used. Can be a raster SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or vector SaveFormat.SVG.
    On different platforms, the supported formats may be different. The number of other options depends on the selected format.
    
    Also, it is possible to save to SVG both via ImageSaveOptions and via SvgSaveOptions.
    
    Specified by:
    
    getSaveFormat in class SaveOptions
    
    Returns:
    
    The corresponding int value. The returned value is one of SaveFormat constants.
  - setSaveFormat
```
public void setSaveFormat(int value)
```
    Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used. Can be a raster SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or vector SaveFormat.SVG.
    On different platforms, the supported formats may be different. The number of other options depends on the selected format.
    
    Also, it is possible to save to SVG both via ImageSaveOptions and via SvgSaveOptions.
    
    Specified by:
    
    setSaveFormat in class SaveOptions
    
    Parameters:
    
    value - The corresponding int value. The value must be one of SaveFormat constants.
  - getPageSet
```
public PageSet getPageSet()
```
    Gets the pages to render. Default is all the pages in the document.
    This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.
    
    Overrides:
    
    getPageSet in class FixedPageSaveOptions
    
    Returns:
    
    The pages to render.
  - setPageSet
```
public void setPageSet(PageSet value)
```
    Sets the pages to render. Default is all the pages in the document.
    This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.
    
    Overrides:
    
    setPageSet in class FixedPageSaveOptions
    
    Parameters:
    
    value - The pages to render.
  - getPaperColor
```
public java.awt.Color getPaperColor()
```
    Gets the background (paper) color for the generated images.
    The default value is .
    
    When rendering pages of a document that specifies its own background color, then the document background color will override the color specified by this property.
    
    Returns:
    
    The background (paper) color for the generated images.
  - setPaperColor
```
public void setPaperColor(java.awt.Color value)
```
    Sets the background (paper) color for the generated images.
    The default value is .
    
    When rendering pages of a document that specifies its own background color, then the document background color will override the color specified by this property.
    
    Parameters:
    
    value - The background (paper) color for the generated images.
  - getPixelFormat
```
public int getPixelFormat()
```
    Gets the pixel format for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is ImagePixelFormat.FORMAT_32_BPP_ARGB.
    
    Pixel format of the output image may differ from the set value because of work of GDI+.
    
    Returns:
    
    The pixel format for the generated images. The returned value is one of ImagePixelFormat constants.
  - setPixelFormat
```
public void setPixelFormat(int value)
```
    Sets the pixel format for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is ImagePixelFormat.FORMAT_32_BPP_ARGB.
    
    Pixel format of the output image may differ from the set value because of work of GDI+.
    
    Parameters:
    
    value - The pixel format for the generated images. The value must be one of ImagePixelFormat constants.
  - getHorizontalResolution
```
public float getHorizontalResolution()
```
    Gets the horizontal resolution for the generated images, in dots per inch.
    This property has effect only when saving to raster image formats and affects the output size in pixels.
    
    The default value is 96.
    
    Returns:
    
    The horizontal resolution for the generated images, in dots per inch.
  - setHorizontalResolution
```
public void setHorizontalResolution(float value)
```
    Sets the horizontal resolution for the generated images, in dots per inch.
    This property has effect only when saving to raster image formats and affects the output size in pixels.
    
    The default value is 96.
    
    Parameters:
    
    value - The horizontal resolution for the generated images, in dots per inch.
  - getVerticalResolution
```
public float getVerticalResolution()
```
    Gets the vertical resolution for the generated images, in dots per inch.
    This property has effect only when saving to raster image formats and affects the output size in pixels.
    
    The default value is 96.
    
    Returns:
    
    The vertical resolution for the generated images, in dots per inch.
  - setVerticalResolution
```
public void setVerticalResolution(float value)
```
    Sets the vertical resolution for the generated images, in dots per inch.
    This property has effect only when saving to raster image formats and affects the output size in pixels.
    
    The default value is 96.
    
    Parameters:
    
    value - The vertical resolution for the generated images, in dots per inch.
  - setResolution
```
public void setResolution(float value)
```
    Sets both horizontal and vertical resolution for the generated images, in dots per inch.
    This property has effect only when saving to raster image formats.
    
    Parameters:
    
    value - Both horizontal and vertical resolution for the generated images, in dots per inch.
  - getJpegQuality
```
public int getJpegQuality()
```
    Gets a value determining the quality of the generated JPEG images.
    Has effect only when saving to JPEG.
    
    Use this property to get or set the quality of generated images when saving in JPEG format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.
    
    The default value is 95.
    
    Overrides:
    
    getJpegQuality in class FixedPageSaveOptions
    
    Returns:
    
    A value determining the quality of the generated JPEG images.
  - setJpegQuality
```
public void setJpegQuality(int value)
```
    Sets a value determining the quality of the generated JPEG images.
    Has effect only when saving to JPEG.
    
    Use this property to get or set the quality of generated images when saving in JPEG format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.
    
    The default value is 95.
    
    Overrides:
    
    setJpegQuality in class FixedPageSaveOptions
    
    Parameters:
    
    value - A value determining the quality of the generated JPEG images.
  - getTiffCompression
```
public int getTiffCompression()
```
    Gets the type of compression to apply when saving generated images to the TIFF format.
    Has effect only when saving to TIFF.
    
    The default value is TiffCompression.CCITT_4.
    
    Returns:
    
    The type of compression to apply when saving generated images to the TIFF format. The returned value is one of TiffCompression constants.
  - setTiffCompression
```
public void setTiffCompression(int value)
```
    Sets the type of compression to apply when saving generated images to the TIFF format.
    Has effect only when saving to TIFF.
    
    The default value is TiffCompression.CCITT_4.
    
    Parameters:
    
    value - The type of compression to apply when saving generated images to the TIFF format. The value must be one of TiffCompression constants.
  - getImageColorMode
```
public int getImageColorMode()
```
    Gets the color mode for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is ImageColorMode.NONE.
    
    Returns:
    
    The color mode for the generated images. The returned value is one of ImageColorMode constants.
  - setImageColorMode
```
public void setImageColorMode(int value)
```
    Sets the color mode for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is ImageColorMode.NONE.
    
    Parameters:
    
    value - The color mode for the generated images. The value must be one of ImageColorMode constants.
  - getImageBrightness
```
public float getImageBrightness()
```
    Gets the brightness for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is 0.5. The value must be in the range between 0 and 1.
    
    Returns:
    
    The brightness for the generated images.
  - setImageBrightness
```
public void setImageBrightness(float value)
```
    Sets the brightness for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is 0.5. The value must be in the range between 0 and 1.
    
    Parameters:
    
    value - The brightness for the generated images.
  - getImageContrast
```
public float getImageContrast()
```
    Gets the contrast for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is 0.5. The value must be in the range between 0 and 1.
    
    Returns:
    
    The contrast for the generated images.
  - setImageContrast
```
public void setImageContrast(float value)
```
    Sets the contrast for the generated images.
    This property has effect only when saving to raster image formats.
    
    The default value is 0.5. The value must be in the range between 0 and 1.
    
    Parameters:
    
    value - The contrast for the generated images.
  - getScale
```
public float getScale()
```
    Gets the zoom factor for the generated images. The default value is 1.0. The value must be greater than 0.
    
    Returns:
    
    The zoom factor for the generated images.
  - setScale
```
public void setScale(float value)
```
    Sets the zoom factor for the generated images. The default value is 1.0. The value must be greater than 0.
    
    Parameters:
    
    value - The zoom factor for the generated images.
  - getMetafileRenderingOptions
```
public MetafileRenderingOptions getMetafileRenderingOptions()
```
    Allows to specify how metafiles are treated in the rendered output.
    When MetafileRenderingMode.VECTOR is specified, Aspose.Words renders metafile to vector graphics using its own metafile rendering engine first and then renders vector graphics to the image.
    
    When MetafileRenderingMode.BITMAP is specified, Aspose.Words renders metafile directly to the image using the GDI+ metafile rendering engine.
    
    GDI+ metafile rendering engine works faster, supports almost all metafile features but on low resolutions may produce inconsistent result when compared to the rest of vector graphics (especially for text) on the page. Aspose.Words metafile rendering engine will produce more consistent result even on low resolutions but works slower and may inaccurately render complex metafiles.
    
    The default value for MetafileRenderingMode is MetafileRenderingMode.BITMAP.
    
    Overrides:
    
    getMetafileRenderingOptions in class FixedPageSaveOptions
    
    Returns:
    
    The corresponding MetafileRenderingOptions value.
  - getTiffBinarizationMethod
```
public int getTiffBinarizationMethod()
```
    Gets method used while converting images to 1 bpp format when getSaveFormat() / setSaveFormat(int) is SaveFormat.Tiff and getTiffCompression() / setTiffCompression(int) is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4.
    The default value is ImageBinarizationMethod.Threshold.
    
    Returns:
    
    Method used while converting images to 1 bpp format when getSaveFormat() / setSaveFormat(int) is SaveFormat.Tiff and getTiffCompression() / setTiffCompression(int) is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4. The returned value is one of ImageBinarizationMethod constants.
  - setTiffBinarizationMethod
```
public void setTiffBinarizationMethod(int value)
```
    Sets method used while converting images to 1 bpp format when getSaveFormat() / setSaveFormat(int) is SaveFormat.Tiff and getTiffCompression() / setTiffCompression(int) is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4.
    The default value is ImageBinarizationMethod.Threshold.
    
    Parameters:
    
    value - Method used while converting images to 1 bpp format when getSaveFormat() / setSaveFormat(int) is SaveFormat.Tiff and getTiffCompression() / setTiffCompression(int) is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4. The value must be one of ImageBinarizationMethod constants.
  - getThresholdForFloydSteinbergDithering
```
public byte getThresholdForFloydSteinbergDithering()
```
    Gets the threshold that determines the value of the binarization error in the Floyd-Steinberg method. when ImageBinarizationMethod is ImageBinarizationMethod.FloydSteinbergDithering.
    The default value is 128.
    
    Returns:
    
    The threshold that determines the value of the binarization error in the Floyd-Steinberg method.
  - setThresholdForFloydSteinbergDithering
```
public void setThresholdForFloydSteinbergDithering(byte value)
```
    Sets the threshold that determines the value of the binarization error in the Floyd-Steinberg method. when ImageBinarizationMethod is ImageBinarizationMethod.FloydSteinbergDithering.
    The default value is 128.
    
    Parameters:
    
    value - The threshold that determines the value of the binarization error in the Floyd-Steinberg method.
  - getGraphicsQualityOptions
```
public GraphicsQualityOptions getGraphicsQualityOptions()
```
    Allows to specify rendering mode and quality for the Graphics2D object.
    Use this property to override the Graphics settings provided by Aspose.Words engine by default.
    
    It will take effect only when a document is being saved to an image-like format.
    
    Returns:
    
    The corresponding GraphicsQualityOptions value.
  - setGraphicsQualityOptions
```
public void setGraphicsQualityOptions(GraphicsQualityOptions value)
```
    Allows to specify rendering mode and quality for the Graphics2D object.
    Use this property to override the Graphics settings provided by Aspose.Words engine by default.
    
    It will take effect only when a document is being saved to an image-like format.
    
    Parameters:
    
    value - The corresponding GraphicsQualityOptions value.
  - getUseGdiEmfRenderer
```
public boolean getUseGdiEmfRenderer()
```
    Gets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
    If set to true GDI+ metafile renderer is used. I.e. content is written to GDI+ graphics object and saved to metafile.
    
    If set to false Aspose.Words metafile renderer is used. I.e. content is written directly to the metafile format with Aspose.Words.
    
    Has effect only when saving to EMF.
    
    GDI+ saving works only on .NET.
    
    The default value is true.
    
    Returns:
    
    A value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
  - setUseGdiEmfRenderer
```
public void setUseGdiEmfRenderer(boolean value)
```
    Sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
    If set to true GDI+ metafile renderer is used. I.e. content is written to GDI+ graphics object and saved to metafile.
    
    If set to false Aspose.Words metafile renderer is used. I.e. content is written directly to the metafile format with Aspose.Words.
    
    Has effect only when saving to EMF.
    
    GDI+ saving works only on .NET.
    
    The default value is true.
    
    Parameters:
    
    value - A value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
  - deepClone
```
public ImageSaveOptions deepClone()
```
    Creates a deep clone of this object.
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class ImageSaveOptions

Constructor Summary

Method Summary

Methods inherited from class com.aspose.words.FixedPageSaveOptions

Methods inherited from class com.aspose.words.SaveOptions

Methods inherited from class java.lang.Object

Constructor Detail

ImageSaveOptions

Method Detail

getSaveFormat

setSaveFormat

getPageSet

setPageSet

getPaperColor

setPaperColor

getPixelFormat

setPixelFormat

getHorizontalResolution

setHorizontalResolution

getVerticalResolution

setVerticalResolution

setResolution

getJpegQuality

setJpegQuality

getTiffCompression

setTiffCompression

getImageColorMode

setImageColorMode

getImageBrightness

setImageBrightness

getImageContrast

setImageContrast

getScale

setScale

getMetafileRenderingOptions

getTiffBinarizationMethod

setTiffBinarizationMethod

getThresholdForFloydSteinbergDithering

setThresholdForFloydSteinbergDithering

getGraphicsQualityOptions

setGraphicsQualityOptions

getUseGdiEmfRenderer

setUseGdiEmfRenderer

deepClone

memberwiseClone