Package com.ironsoftware.ironpdf.image

Class ToImageOptions

java.lang.Object

com.ironsoftware.ironpdf.image.ToImageOptions

public class ToImageOptions
extends Object

Defines options when rasterizing (converting) an PDf to image objects and files.

See: PdfDocument.toImages(String, String, ToImageOptions) and PdfDocument.toBufferedImages(ToImageOptions options)

Constructor Summary

Constructors

Constructor	Description
ToImageOptions()

Method Summary

Modifier and Type	Method	Description
int	getDpi()	Gets dpi.
Integer	getImageMaxHeight()	Gets image max height.
Integer	getImageMaxWidth()	Gets image max width.
void	setDpi(int dpi)	Sets dpi.
void	setImageMaxHeight(Integer imageMaxHeight)	Sets image max height.
void	setImageMaxWidth(Integer imageMaxWidth)	Sets image max width.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ToImageOptions

public ToImageOptions()

Method Details

getDpi

public int getDpi()

Gets dpi. The desired resolution of the output Images. Default is 96dpi.

Returns:

the dpi

setDpi

public void setDpi(int dpi)

Sets dpi. The desired resolution of the output Images. Default is 96dpi.

Parameters:

dpi - the dpi

getImageMaxHeight

public Integer getImageMaxHeight()

Gets image max height. The target maximum height of the output images. Default is null.

Returns:

the image max height

setImageMaxHeight

public void setImageMaxHeight(Integer imageMaxHeight)

Sets image max height. The target maximum height of the output images. Default is null.

Parameters:

imageMaxHeight - the image max height

getImageMaxWidth

public Integer getImageMaxWidth()

Gets image max width. The target maximum width of the output images. Default is null.

Returns:

the image max width

setImageMaxWidth

public void setImageMaxWidth(Integer imageMaxWidth)

Sets image max width. The target maximum width of the output images. Default is null.

Parameters:

imageMaxWidth - the image max width