SpreadsheetPreviewOptions
Inheritance: java.lang.Object, com.groupdocs.watermark.options.PreviewOptions
public class SpreadsheetPreviewOptions extends PreviewOptions
Provides options to sets requirements and stream delegates for preview generation of Spreadsheet document.
Constructors
| Constructor | Description |
|---|---|
| SpreadsheetPreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the [SpreadsheetPreviewOptions](../../com.groupdocs.watermark.options/spreadsheetpreviewoptions) class causing the output stream to be closed. |
| SpreadsheetPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of [SpreadsheetPreviewOptions](../../com.groupdocs.watermark.options/spreadsheetpreviewoptions) class causing the output stream to be returned to the client for further use. |
Fields
| Field | Description |
|---|---|
| DefaultResolution | Default resolution in dots per inch. |
Methods
| Method | Description |
|---|---|
| getResolution() | Gets the resolution for the generated images, in dots per inch. |
| setResolution(int value) | Sets the resolution for the generated images, in dots per inch. |
| getOnlyDataArea() | Gets the flag for rendering the data area only without headers, footers, margins. |
| setOnlyDataArea(boolean value) | Sets the flag for rendering the data area only without headers, footers, margins. |
SpreadsheetPreviewOptions(ICreatePageStream createPageStream)
public SpreadsheetPreviewOptions(ICreatePageStream createPageStream)
Initializes a new instance of the [SpreadsheetPreviewOptions](../../com.groupdocs.watermark.options/spreadsheetpreviewoptions) class causing the output stream to be closed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
SpreadsheetPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
public SpreadsheetPreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
Initializes a new instance of [SpreadsheetPreviewOptions](../../com.groupdocs.watermark.options/spreadsheetpreviewoptions) class causing the output stream to be returned to the client for further use.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets the output stream. |
DefaultResolution
public static final int DefaultResolution
Default resolution in dots per inch.
getResolution()
public final int getResolution()
Gets the resolution for the generated images, in dots per inch.
Returns: int - The resolution for the generated images, in dots per inch.
The default value is 96.
setResolution(int value)
public final void setResolution(int value)
Sets the resolution for the generated images, in dots per inch.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The resolution for the generated images, in dots per inch. |
The default value is 96. |
getOnlyDataArea()
public final boolean getOnlyDataArea()
Gets the flag for rendering the data area only without headers, footers, margins.
Returns: boolean - 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 .
setOnlyDataArea(boolean value)
public final void setOnlyDataArea(boolean value)
Sets the flag for rendering the data area only without headers, footers, margins.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | 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 . |