public class PreviewOptions extends Object
Represents document preview options.
Constructor and Description |
---|
PreviewOptions(CreatePageStream createPageStream)
Initializes a new instance of
PreviewOptions class. |
PreviewOptions(CreatePageStream createPageStream,
ReleasePageStream releasePageStream)
Initializes a new instance of
PreviewOptions class. |
Modifier and Type | Method and Description |
---|---|
CreatePageStream |
getCreatePageStream()
Delegate which defines method to create output page preview stream.
|
int |
getHeight()
Page preview height.
|
int[] |
getPageNumbers()
Page numbers that will be previewed.
|
int |
getPreviewFormat()
Preview image format.
|
ReleasePageStream |
getReleasePageStream()
Delegate which defines method to remove output page preview stream
|
boolean |
getRenderComments()
The property that controls whether comments will be generated on the
preview.
|
int |
getWidth()
Page preview width.
|
List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> |
getWorksheetColumns()
Worksheet columns to generate.
|
com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> |
getWorksheetColumnsInternal() |
void |
setCreatePageStream(CreatePageStream value)
Delegate which defines method to create output page preview stream.
|
void |
setHeight(int value)
Page preview height.
|
void |
setPageNumbers(int[] value)
Page numbers that will be previewed.
|
void |
setPreviewFormat(int value)
Preview image format.
|
void |
setReleasePageStream(ReleasePageStream value)
Delegate which defines method to remove output page preview stream
|
void |
setRenderComments(boolean value)
The property that controls whether comments will be generated on the
preview.
|
void |
setWidth(int value)
Page preview width.
|
void |
setWorksheetColumns(List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> value)
Worksheet columns to generate.
|
void |
setWorksheetColumnsInternal(com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> value) |
public PreviewOptions(CreatePageStream createPageStream)
Initializes a new instance of PreviewOptions
class.
createPageStream
- Delegate which defines method to create output
page preview stream.public PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)
Initializes a new instance of PreviewOptions
class.
createPageStream
- Delegate which defines method to create output
page preview stream.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.
public final int getHeight()
Page preview height.
public final int[] getPageNumbers()
Page numbers that will be previewed.
public final int getPreviewFormat()
Preview image format.
public final ReleasePageStream getReleasePageStream()
Delegate which defines method to remove output page preview stream
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
public final int getWidth()
Page preview width.
public final List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> getWorksheetColumns()
Worksheet columns to generate. Generation proceeds in the specified order.
public com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> getWorksheetColumnsInternal()
public final void setCreatePageStream(CreatePageStream value)
Delegate which defines method to create output page preview stream.
value
- public final void setHeight(int value)
Page preview height.
value
- public final void setPageNumbers(int[] value)
Page numbers that will be previewed.
value
- public final void setPreviewFormat(int value)
Preview image format.
value
- public final void setReleasePageStream(ReleasePageStream value)
Delegate which defines method to remove output page preview stream
value
- 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
value
- public final void setWidth(int value)
Page preview width.
value
- public final void setWorksheetColumns(List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> value)
Worksheet columns to generate. Generation proceeds in the specified order.
value
- public void setWorksheetColumnsInternal(com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> value)