PreviewOptions Leave feedback
On this page
Inheritance: java.lang.Object
public class PreviewOptions
Represents document preview options.
| Constructor | Description |
|---|---|
| PreviewOptions(CreatePageStream createPageStream) | Initializes a new instance of PreviewOptions class. |
| PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream) | Initializes a new instance of PreviewOptions class. |
| Method | Description |
|---|---|
| getCreatePageStream() | Delegate which defines method to create output page preview stream. |
| setCreatePageStream(CreatePageStream value) | Delegate which defines method to create output page preview stream. |
| getReleasePageStream() | Delegate which defines method to remove output page preview stream |
| setReleasePageStream(ReleasePageStream value) | Delegate which defines method to remove output page preview stream |
| getWidth() | Page preview width. |
| setWidth(int value) | Page preview width. |
| getHeight() | Page preview height. |
| setHeight(int value) | Page preview height. |
| getPageNumbers() | Page numbers that will be previewed. |
| setPageNumbers(int[] value) | Page numbers that will be previewed. |
| getPreviewFormat() | Preview image format. |
| setPreviewFormat(int value) | Preview image format. |
| getResolution() | |
| setResolution(int value) | |
| getRenderComments() | The property that controls whether comments will be generated on the preview. |
| setRenderComments(boolean value) | The property that controls whether comments will be generated on the preview. |
| getRenderAnnotations() | The property that controls whether annotations will be generated on the preview. |
| setRenderAnnotations(boolean value) | The property that controls whether annotations will be generated on the preview. |
| getWorksheetColumns() | Worksheet columns to generate. |
| getWorksheetColumnsInternal() | |
| setWorksheetColumns(List |
Worksheet columns to generate. |
| setWorksheetColumnsInternal(System.Collections.Generic.List |
public PreviewOptions(CreatePageStream createPageStream)
Initializes a new instance of PreviewOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |
public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
Initializes a new instance of PreviewOptions class.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| createPageStream | CreatePageStream | Delegate which defines method to create output page preview stream. |
| releasePageStream | ReleasePageStream | Delegate which defines method to release output page preview stream. |
public final CreatePageStream getCreatePageStream()
Delegate which defines method to create output page preview stream.
Returns: CreatePageStream -
public final void setCreatePageStream(CreatePageStream value)
Delegate which defines method to create output page preview stream.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CreatePageStream |
public final ReleasePageStream getReleasePageStream()
Delegate which defines method to remove output page preview stream
Returns: ReleasePageStream -
public final void setReleasePageStream(ReleasePageStream value)
Delegate which defines method to remove output page preview stream
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ReleasePageStream |
public final int getWidth()
Page preview width.
Returns: int -
public final void setWidth(int value)
Page preview width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getHeight()
Page preview height.
Returns: int -
public final void setHeight(int value)
Page preview height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int[] getPageNumbers()
Page numbers that will be previewed.
Returns: int[] -
public final void setPageNumbers(int[] value)
Page numbers that will be previewed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int[] |
public final int getPreviewFormat()
Preview image format.
Returns: int -
public final void setPreviewFormat(int value)
Preview image format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public int getResolution()
Returns: int
public void setResolution(int value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final boolean getRenderComments()
The property that controls whether comments will be generated on the preview. Default State - true. Now Supported only in MS Word document
Returns: boolean -
public final void setRenderComments(boolean value)
The property that controls whether comments will be generated on the preview. Default State - true. Now Supported only in MS Word document
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final boolean getRenderAnnotations()
The property that controls whether annotations will be generated on the preview. Default State - true.
Returns: boolean -
public final void setRenderAnnotations(boolean value)
The property that controls whether annotations will be generated on the preview. Default State - true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final List<WorksheetColumnsRange> getWorksheetColumns()
Worksheet columns to generate. Generation proceeds in the specified order.
Returns: java.util.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> -
public System.Collections.Generic.List<WorksheetColumnsRange> getWorksheetColumnsInternal()
Returns: com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange>
public final void setWorksheetColumns(List<WorksheetColumnsRange> value)
Worksheet columns to generate. Generation proceeds in the specified order.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> |
public void setWorksheetColumnsInternal(System.Collections.Generic.List<WorksheetColumnsRange> value)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> |
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.