ImageSaveOptions

Inheritance: java.lang.Object, com.aspose.note.SaveOptions

public class ImageSaveOptions extends SaveOptions

Allows to specify additional options when rendering document pages to images.

Constructors

ConstructorDescription
ImageSaveOptions(int format)Initializes a new instance of the ImageSaveOptions class.

Methods

MethodDescription
getResolution()Gets the resolution for the generated images, in dots per inch.
setResolution(float value)Sets the resolution for the generated images, in dots per inch.
getQuality()Gets a value determining the quality of saved image.
setQuality(int value)Sets a value determining the quality of saved image.
getColorMode()Gets or sets ColorMode (#getColorMode.getColorMode/#setColorMode(int).setColorMode(int)) for the output image.
setColorMode(int value)Gets or sets ColorMode (#getColorMode.getColorMode/#setColorMode(int).setColorMode(int)) for the output image.
getBinarizationOptions()Gets or sets options for image’s binarization.
setBinarizationOptions(ImageBinarizationOptions value)Gets or sets options for image’s binarization.
getTiffCompression()Gets or sets the type of compression to use when saving generated images to the TIFF format.
setTiffCompression(int value)Gets or sets the type of compression to use when saving generated images to the TIFF format.

ImageSaveOptions(int format)

public ImageSaveOptions(int format)

Initializes a new instance of the ImageSaveOptions class.

Parameters:

ParameterTypeDescription
formatintThe format in which the document is saved.

getResolution()

public float getResolution()

Gets the resolution for the generated images, in dots per inch.


The default value is 96.

Returns: float

setResolution(float value)

public void setResolution(float value)

Sets the resolution for the generated images, in dots per inch.


The default value is 90.

Parameters:

ParameterTypeDescription
valuefloat

getQuality()

public final int getQuality()

Gets a value determining the quality of saved image. This value is passed to codec as System.Drawing.Imaging.Encoder.Quality parameter.


The range of useful values for the quality category is from 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. Zero would give you the lowest quality image and 100 the highest. The default value is 90.

Returns: int

setQuality(int value)

public final void setQuality(int value)

Sets a value determining the quality of saved image. This value is passed to codec as System.Drawing.Imaging.Encoder.Quality parameter.


The range of useful values for the quality category is from 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. Zero would give you the lowest quality image and 100 the highest. The default value is 90.

Parameters:

ParameterTypeDescription
valueint

getColorMode()

public final int getColorMode()

Gets or sets ColorMode (#getColorMode.getColorMode/#setColorMode(int).setColorMode(int)) for the output image.

Returns: int

setColorMode(int value)

public final void setColorMode(int value)

Gets or sets ColorMode (#getColorMode.getColorMode/#setColorMode(int).setColorMode(int)) for the output image.

Parameters:

ParameterTypeDescription
valueint

getBinarizationOptions()

public final ImageBinarizationOptions getBinarizationOptions()

Gets or sets options for image’s binarization.

Returns: ImageBinarizationOptions

setBinarizationOptions(ImageBinarizationOptions value)

public final void setBinarizationOptions(ImageBinarizationOptions value)

Gets or sets options for image’s binarization.

Parameters:

ParameterTypeDescription
valueImageBinarizationOptions

getTiffCompression()

public final int getTiffCompression()

Gets or sets the type of compression to use when saving generated images to the TIFF format.

Returns: int

setTiffCompression(int value)

public final void setTiffCompression(int value)

Gets or sets the type of compression to use when saving generated images to the TIFF format.

Parameters:

ParameterTypeDescription
valueint