Packages

com.groupdocs.conversion.options.convert

Interfaces

Classes

Enums

Skip navigation links

java.lang.Object
- com.groupdocs.conversion.contracts.ValueObject
- - com.groupdocs.conversion.options.convert.ConvertOptions<TFileType>
  - - com.groupdocs.conversion.options.convert.CommonConvertOptions<ImageFileType>
    - - com.groupdocs.conversion.options.convert.ImageConvertOptions

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ValueObject>, IConvertOptions, IPagedConvertOptions, IPageRangedConvertOptions, IWatermarkedConvertOptions, Serializable, Cloneable
```
public final class ImageConvertOptions
extends CommonConvertOptions<ImageFileType>
implements Serializable
```
Options for conversion to Image file type.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_DPI

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_DPI`

Constructor Summary

Constructors
Constructor and Description

ImageConvertOptions()
Initializes new instance of ImageConvertOptions class.

Constructors
Constructor and Description
`ImageConvertOptions()` Initializes new instance of `ImageConvertOptions` class.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.aspose.ms.System.Drawing.Color`	`getBackgroundColor()` Gets background color
`int`	`getBrightness()` Adjusts image brightness.
`int`	`getContrast()` Adjusts image contrast.
`ImageFlipModes`	`getFlipMode()` Image flip mode.
`float`	`getGamma()` Adjusts image gamma.
`boolean`	`getGrayscale()` Indicates whether to convert into grayscale image.
`int`	`getHeight()` Desired image height after conversion.
`int`	`getHorizontalResolution()` Desired image horizontal resolution after conversion.
`JpegOptions`	`getJpegOptions()` Jpeg specific convert options.
`PsdOptions`	`getPsdOptions()` Psd specific convert options.
`int`	`getRotateAngle()` Image rotation angle.
`TiffOptions`	`getTiffOptions()` Tiff specific convert options.
`boolean`	`getUsePdf()` If `true`, the input firstly is converted to PDF and after that to desired format.
`int`	`getVerticalResolution()` Desired image vertical resolution after conversion.
`WebpOptions`	`getWebpOptions()` Webp specific convert options.
`int`	`getWidth()` Desired image width after conversion.
`void`	`setBackgroundColor(com.aspose.ms.System.Drawing.Color backgroundColor)` Sets background color where supported by the source format
`void`	`setBrightness(int value)` Adjusts image brightness.
`void`	`setContrast(int value)` Adjusts image contrast.
`void`	`setFlipMode(ImageFlipModes value)` Image flip mode.
`void`	`setGamma(float value)` Adjusts image gamma.
`void`	`setGrayscale(boolean value)` Indicates whether to convert into grayscale image.
`void`	`setHeight(int value)` Desired image height after conversion.
`void`	`setHorizontalResolution(int value)` Desired image horizontal resolution after conversion.
`void`	`setJpegOptions(JpegOptions value)` Jpeg specific convert options.
`void`	`setPsdOptions(PsdOptions value)` Psd specific convert options.
`void`	`setRotateAngle(int value)` Image rotation angle.
`void`	`setTiffOptions(TiffOptions value)` Tiff specific convert options.
`void`	`setUsePdf(boolean value)` If `true`, the input firstly is converted to PDF and after that to desired format.
`void`	`setVerticalResolution(int value)` Desired image vertical resolution after conversion.
`void`	`setWebpOptions(WebpOptions value)` Webp specific convert options.
`void`	`setWidth(int value)` Desired image width after conversion.

Methods inherited from class com.groupdocs.conversion.options.convert.CommonConvertOptions
getPageNumber, getPages, getPagesCount, getWatermark, setPageNumber, setPages, setPagesCount, setWatermark

Methods inherited from class com.groupdocs.conversion.options.convert.ConvertOptions
deepClone, getFormat_ConvertOptions_New, getFormat, setFormat_ConvertOptions_New, setFormat

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject
equals, equals, hashCode, op_Equality, op_Inequality

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

Methods inherited from interface com.groupdocs.conversion.options.convert.IConvertOptions
getFormat, setFormat

- Field Detail
  - DEFAULT_DPI
```
public static final int DEFAULT_DPI
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ImageConvertOptions
```
public ImageConvertOptions()
```
    Initializes new instance of ImageConvertOptions class.
- Method Detail
  - getWidth
```
public final int getWidth()
```
    Desired image width after conversion.
  - setWidth
```
public final void setWidth(int value)
```
    Desired image width after conversion.
  - getHeight
```
public final int getHeight()
```
    Desired image height after conversion.
  - setHeight
```
public final void setHeight(int value)
```
    Desired image height after conversion.
  - getUsePdf
```
public final boolean getUsePdf()
```
    If true, the input firstly is converted to PDF and after that to desired format.
  - setUsePdf
```
public final void setUsePdf(boolean value)
```
    If true, the input firstly is converted to PDF and after that to desired format.
  - getHorizontalResolution
```
public final int getHorizontalResolution()
```
    Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.
  - setHorizontalResolution
```
public final void setHorizontalResolution(int value)
```
    Desired image horizontal resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.
  - getVerticalResolution
```
public final int getVerticalResolution()
```
    Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.
  - setVerticalResolution
```
public final void setVerticalResolution(int value)
```
    Desired image vertical resolution after conversion. The default resolution is the resolution of the input file or 96 dpi.
  - getTiffOptions
```
public final TiffOptions getTiffOptions()
```
    Tiff specific convert options.
  - setTiffOptions
```
public final void setTiffOptions(TiffOptions value)
```
    Tiff specific convert options.
  - getPsdOptions
```
public final PsdOptions getPsdOptions()
```
    Psd specific convert options.
  - setPsdOptions
```
public final void setPsdOptions(PsdOptions value)
```
    Psd specific convert options.
  - getWebpOptions
```
public final WebpOptions getWebpOptions()
```
    Webp specific convert options.
  - setWebpOptions
```
public final void setWebpOptions(WebpOptions value)
```
    Webp specific convert options.
  - getGrayscale
```
public final boolean getGrayscale()
```
    Indicates whether to convert into grayscale image.
  - setGrayscale
```
public final void setGrayscale(boolean value)
```
    Indicates whether to convert into grayscale image.
  - getRotateAngle
```
public final int getRotateAngle()
```
    Image rotation angle.
  - setRotateAngle
```
public final void setRotateAngle(int value)
```
    Image rotation angle.
  - getJpegOptions
```
public final JpegOptions getJpegOptions()
```
    Jpeg specific convert options.
  - setJpegOptions
```
public final void setJpegOptions(JpegOptions value)
```
    Jpeg specific convert options.
  - getFlipMode
```
public final ImageFlipModes getFlipMode()
```
    Image flip mode.
  - setFlipMode
```
public final void setFlipMode(ImageFlipModes value)
```
    Image flip mode.
  - getBrightness
```
public final int getBrightness()
```
    Adjusts image brightness.
  - setBrightness
```
public final void setBrightness(int value)
```
    Adjusts image brightness.
  - getContrast
```
public final int getContrast()
```
    Adjusts image contrast.
  - setContrast
```
public final void setContrast(int value)
```
    Adjusts image contrast.
  - getGamma
```
public final float getGamma()
```
    Adjusts image gamma.
  - setGamma
```
public final void setGamma(float value)
```
    Adjusts image gamma.
  - getBackgroundColor
```
public com.aspose.ms.System.Drawing.Color getBackgroundColor()
```
    Gets background color
    
    Returns:
    
    background color
  - setBackgroundColor
```
public void setBackgroundColor(com.aspose.ms.System.Drawing.Color backgroundColor)
```
    Sets background color where supported by the source format
    
    Parameters:
    
    backgroundColor - background color

Packages

com.groupdocs.conversion.options.convert

Interfaces

Classes

Enums

Class ImageConvertOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.groupdocs.conversion.options.convert.CommonConvertOptions

Methods inherited from class com.groupdocs.conversion.options.convert.ConvertOptions

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject

Methods inherited from class java.lang.Object

Methods inherited from interface com.groupdocs.conversion.options.convert.IConvertOptions

Field Detail

DEFAULT_DPI

Constructor Detail

ImageConvertOptions

Method Detail

getWidth

setWidth

getHeight

setHeight

getUsePdf

setUsePdf

getHorizontalResolution

setHorizontalResolution

getVerticalResolution

setVerticalResolution

getTiffOptions

setTiffOptions

getPsdOptions

setPsdOptions

getWebpOptions

setWebpOptions

getGrayscale

setGrayscale

getRotateAngle

setRotateAngle

getJpegOptions

setJpegOptions

getFlipMode

setFlipMode

getBrightness

setBrightness

getContrast

setContrast

getGamma

setGamma

getBackgroundColor

setBackgroundColor