com.groupdocs.watermark.options

Class SpreadsheetPreviewOptions

java.lang.Object

com.groupdocs.watermark.options.PreviewOptions

com.groupdocs.watermark.options.SpreadsheetPreviewOptions

public class SpreadsheetPreviewOptions
extends PreviewOptions

Provides options to sets requirements and stream delegates for preview generation of Spreadsheet document.

Nested Class Summary

Nested classes/interfaces inherited from class com.groupdocs.watermark.options.PreviewOptions

PreviewOptions.PreviewFormats

Field Summary

Fields

Modifier and Type	Field and Description
static int	DefaultResolution Default resolution in dots per inch.

Constructor Summary

Constructors

Constructor and Description
SpreadsheetPreviewOptions(ICreatePageStream createPageStream) Initializes a new instance of the SpreadsheetPreviewOptions class causing the output stream to be closed.
SpreadsheetPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) Initializes a new instance of SpreadsheetPreviewOptions class causing the output stream to be returned to the client for further use.

Method Summary

Modifier and Type	Method and Description
boolean	getOnlyDataArea() Gets the flag for rendering the data area only without headers, footers, margins.
int	getResolution() Gets the resolution for the generated images, in dots per inch.
void	setOnlyDataArea(boolean value) Sets the flag for rendering the data area only without headers, footers, margins.
void	setResolution(int value) Sets the resolution for the generated images, in dots per inch.

Methods inherited from class com.groupdocs.watermark.options.PreviewOptions

getCreatePageStream, getHeight, getPageNumbers, getPreviewFormat, getReleasePageStream, getWidth, setCreatePageStream, setHeight, setPageNumbers, setPreviewFormat, setReleasePageStream, setWidth

Methods inherited from class java.lang.Object

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

Field Detail

DefaultResolution

public static final int DefaultResolution

Default resolution in dots per inch.

See Also:

Constant Field Values

Constructor Detail

SpreadsheetPreviewOptions

public SpreadsheetPreviewOptions(ICreatePageStream createPageStream)

Initializes a new instance of the SpreadsheetPreviewOptions class causing the output stream to be closed.

Parameters:

createPageStream - Creates a stream for a specific page preview.

SpreadsheetPreviewOptions

public SpreadsheetPreviewOptions(ICreatePageStream createPageStream,
                                 IReleasePageStream releasePageStream)

Initializes a new instance of SpreadsheetPreviewOptions class causing the output stream to be returned to the client for further use.

Parameters:

createPageStream - Creates a stream for a specific page preview.

releasePageStream - Notifies that the page preview generation is done and gets the output stream.

Method Detail

getOnlyDataArea

public final boolean getOnlyDataArea()

Gets the flag for rendering the data area only without headers, footers, margins.

Returns:

The flag for rendering the data area only without headers, footers, margins.

This flags leads to rendering the whole worksheet on one page. The default value is false.

getResolution

public final int getResolution()

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

Returns:

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

The default value is 96.

setOnlyDataArea

public final void setOnlyDataArea(boolean value)

Sets the flag for rendering the data area only without headers, footers, margins.

Parameters:

value - The flag for rendering the data area only without headers, footers, margins.

This flags leads to rendering the whole worksheet on one page. The default value is false.

setResolution

public final void setResolution(int value)

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

Parameters:

value - The resolution for the generated images, in dots per inch.

The default value is 96.