com.groupdocs.parser.options

Class PagePreviewOptions

java.lang.Object

com.groupdocs.parser.options.PagePreviewOptions

public final class PagePreviewOptions
extends Object

Provides the options which are used to generate the document page preview.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DPI Defines a default value of dpi property.

Constructor Summary

Constructors

Constructor and Description
PagePreviewOptions(int dpi) Initializes a new instance of the PagePreviewOptions class with the preview DPI.
PagePreviewOptions(PagePreviewFormat format) Initializes a new instance of the PagePreviewOptions class with the preview format.
PagePreviewOptions(PagePreviewFormat format, int dpi) Initializes a new instance of the PagePreviewOptions class with the preview format and DPI.

Method Summary

Modifier and Type	Method and Description
int	getDpi() Gets the DPI of the document page image.
PagePreviewFormat	getFormat() Gets the format of the document page image.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DPI

public static final int DEFAULT_DPI

Defines a default value of dpi property.

See Also:

Constant Field Values

Constructor Detail

PagePreviewOptions

public PagePreviewOptions(PagePreviewFormat format)

Initializes a new instance of the PagePreviewOptions class with the preview format.

Parameters:

format - The format of the document page image.

PagePreviewOptions

public PagePreviewOptions(int dpi)

Initializes a new instance of the PagePreviewOptions class with the preview DPI.

Parameters:

dpi - The DPI of the document page image.

PagePreviewOptions

public PagePreviewOptions(PagePreviewFormat format,
                          int dpi)

Initializes a new instance of the PagePreviewOptions class with the preview format and DPI.

Parameters:

format - The format of the document page image.

dpi - The DPI of the document page image.

Method Detail

getFormat

public PagePreviewFormat getFormat()

Gets the format of the document page image.

Returns:

A value that sets the document page image format. If not set, value is PagePreviewFormat.

getDpi

public int getDpi()

Gets the DPI of the document page image.

Returns:

A value that sets the document page DPI. If not set, value is DEFAULT_DPI.