com.groupdocs.annotation.options.pagepreview

Class PreviewOptions

java.lang.Object

com.groupdocs.annotation.options.pagepreview.PreviewOptions

public class PreviewOptions
extends Object

Represents document preview options.

Constructor Summary

Constructors

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.

Method Summary

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	getRenderAnnotations() The property that controls whether annotations will be generated on the preview.
boolean	getRenderComments() The property that controls whether comments will be generated on the preview.
int	getResolution()
int	getWidth() Page preview width.
List<WorksheetColumnsRange>	getWorksheetColumns() Worksheet columns to generate.
com.aspose.ms.System.Collections.Generic.List<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	setRenderAnnotations(boolean value) The property that controls whether annotations will be generated on the preview.
void	setRenderComments(boolean value) The property that controls whether comments will be generated on the preview.
void	setResolution(int value)
void	setWidth(int value) Page preview width.
void	setWorksheetColumns(List<WorksheetColumnsRange> value) Worksheet columns to generate.
void	setWorksheetColumnsInternal(com.aspose.ms.System.Collections.Generic.List<WorksheetColumnsRange> value)

Methods inherited from class java.lang.Object

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

Constructor Detail

PreviewOptions

public PreviewOptions(CreatePageStream createPageStream)

Initializes a new instance of PreviewOptions class.

Parameters:

createPageStream - Delegate which defines method to create output page preview stream.

PreviewOptions

public PreviewOptions(CreatePageStream createPageStream,
                      ReleasePageStream releasePageStream)

Initializes a new instance of PreviewOptions class.

Parameters:

createPageStream - Delegate which defines method to create output page preview stream.

releasePageStream - Delegate which defines method to release output page preview stream.

Method Detail

getCreatePageStream

public final CreatePageStream getCreatePageStream()

Delegate which defines method to create output page preview stream.

Returns:

getHeight

public final int getHeight()

Page preview height.

Returns:

getPageNumbers

public final int[] getPageNumbers()

Page numbers that will be previewed.

Returns:

getPreviewFormat

public final int getPreviewFormat()

Preview image format.

Returns:

getReleasePageStream

public final ReleasePageStream getReleasePageStream()

Delegate which defines method to remove output page preview stream

Returns:

getRenderAnnotations

public final boolean getRenderAnnotations()

The property that controls whether annotations will be generated on the preview. Default State - true.

Returns:

getRenderComments

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:

getResolution

public int getResolution()

getWidth

public final int getWidth()

Page preview width.

Returns:

getWorksheetColumns

public final List<WorksheetColumnsRange> getWorksheetColumns()

Worksheet columns to generate. Generation proceeds in the specified order.

Returns:

getWorksheetColumnsInternal

public com.aspose.ms.System.Collections.Generic.List<WorksheetColumnsRange> getWorksheetColumnsInternal()

setCreatePageStream

public final void setCreatePageStream(CreatePageStream value)

Delegate which defines method to create output page preview stream.

Parameters:

value -

setHeight

public final void setHeight(int value)

Page preview height.

Parameters:

value -

setPageNumbers

public final void setPageNumbers(int[] value)

Page numbers that will be previewed.

Parameters:

value -

setPreviewFormat

public final void setPreviewFormat(int value)

Preview image format.

Parameters:

value -

setReleasePageStream

public final void setReleasePageStream(ReleasePageStream value)

Delegate which defines method to remove output page preview stream

Parameters:

value -

setRenderAnnotations

public final void setRenderAnnotations(boolean value)

The property that controls whether annotations will be generated on the preview. Default State - true.

Parameters:

value -

setRenderComments

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:

value -

setResolution

public void setResolution(int value)

setWidth

public final void setWidth(int value)

Page preview width.

Parameters:

value -

setWorksheetColumns

public final void setWorksheetColumns(List<WorksheetColumnsRange> value)

Worksheet columns to generate. Generation proceeds in the specified order.

Parameters:

value -

setWorksheetColumnsInternal

public void setWorksheetColumnsInternal(com.aspose.ms.System.Collections.Generic.List<WorksheetColumnsRange> value)