PreviewOptions Leave feedback
On this page
Inheritance: java.lang.Object
public class PreviewOptions
Provides options to sets requirements and stream delegates for preview generation.
| Constructor | Description |
|---|---|
| PreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of the [PreviewOptions](../../com.groupdocs.watermark.options/previewoptions) class causing the output stream to be closed. |
| PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of [PreviewOptions](../../com.groupdocs.watermark.options/previewoptions) class causing the output stream to be returned to the client for further use. |
| Method | Description |
|---|---|
| getWidth() | Gets the page preview width. |
| setWidth(int value) | Sets the page preview width. |
| getHeight() | Gets the page preview height. |
| setHeight(int value) | Sets the page preview height. |
| getPageNumbers() | Gets an array of page numbers to generate previews. |
| setPageNumbers(int[] value) | Sets an array of page numbers to generate previews. |
| getPreviewFormat() | Gets the preview image format. |
| setPreviewFormat(int value) | Sets the preview image format. |
| getCreatePageStream() | Gets an instance of the page stream creation class. |
| setCreatePageStream(ICreatePageStream value) | Sets an instance of the page stream creation class. |
| getReleasePageStream() | Gets an instance of the page preview completion class. |
| setReleasePageStream(IReleasePageStream value) | Sets an instance of the page preview completion class. |
public PreviewOptions(ICreatePageStream createPageStream)
Initializes a new instance of the [PreviewOptions](../../com.groupdocs.watermark.options/previewoptions) class causing the output stream to be closed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview. |
public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
Initializes a new instance of [PreviewOptions](../../com.groupdocs.watermark.options/previewoptions) 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. |
public final int getWidth()
Gets the page preview width.
Returns: int - The page preview width.
public final void setWidth(int value)
Sets the page preview width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The page preview width. |
public final int getHeight()
Gets the page preview height.
Returns: int - The page preview height.
public final void setHeight(int value)
Sets the page preview height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The page preview height. |
public final int[] getPageNumbers()
Gets an array of page numbers to generate previews.
Returns: int[] - The array of page numbers to generate previews.
public final void setPageNumbers(int[] value)
Sets an array of page numbers to generate previews.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int[] | The array of page numbers to generate previews. |
public final int getPreviewFormat()
Gets the preview image format.
Returns: int - The preview image format.
public final void setPreviewFormat(int value)
Sets the preview image format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The preview image format. |
public final ICreatePageStream getCreatePageStream()
Gets an instance of the page stream creation class.
Returns: ICreatePageStream - The instance of the page stream creation class.
public final void setCreatePageStream(ICreatePageStream value)
Sets an instance of the page stream creation class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ICreatePageStream | The instance of the page stream creation class. |
public final IReleasePageStream getReleasePageStream()
Gets an instance of the page preview completion class.
Returns: IReleasePageStream - The instance of the page preview completion delegate.
public final void setReleasePageStream(IReleasePageStream value)
Sets an instance of the page preview completion class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IReleasePageStream | The instance of the page preview completion delegate. |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.