XpsConverterToImageOptions

Inheritance: java.lang.Object, com.aspose.xps.plugins.XpsConverterOptions

public class XpsConverterToImageOptions extends XpsConverterOptions

Represents XPS to Image converter options for XpsConverter plugin.

Constructors

ConstructorDescription
XpsConverterToImageOptions()Initializes new instance of the XpsConverterToImageOptions object.
XpsConverterToImageOptions(ImageFormat imageFormat)Initializes new instance of the XpsConverterToImageOptions object with image format.
XpsConverterToImageOptions(Dimension size)Initializes new instance of the XpsConverterToImageOptions object with a size of the resulting image.
XpsConverterToImageOptions(ImageFormat imageFormat, Dimension size)Initializes new instance of the XpsConverterToImageOptions object with image format.

Methods

MethodDescription
addDataSource(IDataSource dataSource)Adds new data source to the XpsConverter plugin data collection.
addSaveDataSource(IDataSource saveDataSource)Adds new data source to the XpsConverterOptions plugin data collection.
equals(Object arg0)
getClass()
getDataCollection()Returns XpsConverterOptions plugin data collection.
getImageFormat()Gets image format.
getJpegQualityLevel()Returns the value specifying the level of compression for an image.
getOperationName()Returns operation name.
getPageNumbers()Gets the array of numbers of pages in XPS document to convert.
getResolution()Gets the image resolution.
getSaveTargetsCollection()Gets collection of added targets for saving operation results.
getSize()Gets the size of the resulting image.
getSmoothingMode()Gets the smoothing mode for rendering image.
hashCode()
notify()
notifyAll()
setImageFormat(ImageFormat imageFormat)Gets image format.
setJpegQualityLevel(int value)Sets the value specifying the level of compression for an image.
setPageNumbers(int[] pageNumbers)Sets the array of numbers of pages in XPS document to convert.
setResolution(int resolution)Sets the image resolution.
setSize(Dimension size)Sets the size of the resulting image.
setSmoothingMode(SmoothingMode smoothingMode)Sets the smoothing mode for rendering image.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

XpsConverterToImageOptions()

public XpsConverterToImageOptions()

Initializes new instance of the XpsConverterToImageOptions object.

XpsConverterToImageOptions(ImageFormat imageFormat)

public XpsConverterToImageOptions(ImageFormat imageFormat)

Initializes new instance of the XpsConverterToImageOptions object with image format.

Parameters:

ParameterTypeDescription
imageFormatImageFormatA format of resulting image.

XpsConverterToImageOptions(Dimension size)

public XpsConverterToImageOptions(Dimension size)

Initializes new instance of the XpsConverterToImageOptions object with a size of the resulting image.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionA size the resulting image.

XpsConverterToImageOptions(ImageFormat imageFormat, Dimension size)

public XpsConverterToImageOptions(ImageFormat imageFormat, Dimension size)

Initializes new instance of the XpsConverterToImageOptions object with image format.

Parameters:

ParameterTypeDescription
imageFormatImageFormatA format of resulting image.
sizejava.awt.Dimension

addDataSource(IDataSource dataSource)

public final void addDataSource(IDataSource dataSource)

Adds new data source to the XpsConverter plugin data collection.

Parameters:

ParameterTypeDescription
dataSourceIDataSourceData source to add.

addSaveDataSource(IDataSource saveDataSource)

public final void addSaveDataSource(IDataSource saveDataSource)

Adds new data source to the XpsConverterOptions plugin data collection.

Parameters:

ParameterTypeDescription
saveDataSourceIDataSourceData source (file or stream) for saving operation results.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getDataCollection()

public final List<IDataSource> getDataCollection()

Returns XpsConverterOptions plugin data collection.

Returns: java.util.List<com.aspose.page.plugins.IDataSource>

getImageFormat()

public ImageFormat getImageFormat()

Gets image format.

Returns: ImageFormat - An image format.

getJpegQualityLevel()

public int getJpegQualityLevel()

Returns the value specifying the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest.

Returns: int - The value specifying the level of compression for an image.

getOperationName()

public final String getOperationName()

Returns operation name.

Returns: java.lang.String

getPageNumbers()

public int[] getPageNumbers()

Gets the array of numbers of pages in XPS document to convert.

Returns: int[] - An array of numbers of pages in XPS document.

getResolution()

public int getResolution()

Gets the image resolution.

Returns: int - An image resolution.

getSaveTargetsCollection()

public final List<IDataSource> getSaveTargetsCollection()

Gets collection of added targets for saving operation results.

Returns: java.util.List<com.aspose.page.plugins.IDataSource>

getSize()

public Dimension getSize()

Gets the size of the resulting image.

Returns: java.awt.Dimension - An image size.

getSmoothingMode()

public SmoothingMode getSmoothingMode()

Gets the smoothing mode for rendering image.

Returns: SmoothingMode - A smoothing mode.

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setImageFormat(ImageFormat imageFormat)

public void setImageFormat(ImageFormat imageFormat)

Gets image format.

Parameters:

ParameterTypeDescription
imageFormatImageFormatA format of resulting image.

setJpegQualityLevel(int value)

public void setJpegQualityLevel(int value)

Sets the value specifying the level of compression for an image. Available values are 0 to 100. The lower the number specified, the higher the compression and therefore the lower the quality of the image. 0 value results in lowest quality image, while 100 results in highest.

Parameters:

ParameterTypeDescription
valueintThe value specifying the level of compression for an image.

setPageNumbers(int[] pageNumbers)

public void setPageNumbers(int[] pageNumbers)

Sets the array of numbers of pages in XPS document to convert. If not set all pages will be converted.

Parameters:

ParameterTypeDescription
pageNumbersint[]An array of numbers of pages in XPS document.

setResolution(int resolution)

public void setResolution(int resolution)

Sets the image resolution.

Parameters:

ParameterTypeDescription
resolutionintA resolution of resulting image.

setSize(Dimension size)

public void setSize(Dimension size)

Sets the size of the resulting image.

Parameters:

ParameterTypeDescription
sizejava.awt.DimensionA size of resulting image.

setSmoothingMode(SmoothingMode smoothingMode)

public void setSmoothingMode(SmoothingMode smoothingMode)

Sets the smoothing mode for rendering image.

Parameters:

ParameterTypeDescription
smoothingModeSmoothingModeA smoothing mode.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int