PreviewOptions

Inheritance: java.lang.Object

public class PreviewOptions

Represents document preview options.

Constructors

Constructor	Description
PreviewOptions(CreatePageStream createPageStream)	Initializes a new instance of PreviewOptions class.
PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)	Initializes a new instance of PreviewOptions class.

Methods

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 value)	Worksheet columns to generate.
setWorksheetColumnsInternal(System.Collections.Generic.List value)

PreviewOptions(CreatePageStream createPageStream)

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.

PreviewOptions(CreatePageStream createPageStream, ReleasePageStream releasePageStream)

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.

getCreatePageStream()

public final CreatePageStream getCreatePageStream()

Delegate which defines method to create output page preview stream.

Returns: CreatePageStream -

setCreatePageStream(CreatePageStream value)

public final void setCreatePageStream(CreatePageStream value)

Delegate which defines method to create output page preview stream.

Parameters:

Parameter	Type	Description
value	CreatePageStream

getReleasePageStream()

public final ReleasePageStream getReleasePageStream()

Delegate which defines method to remove output page preview stream

Returns: ReleasePageStream -

setReleasePageStream(ReleasePageStream value)

public final void setReleasePageStream(ReleasePageStream value)

Delegate which defines method to remove output page preview stream

Parameters:

Parameter	Type	Description
value	ReleasePageStream

getWidth()

public final int getWidth()

Page preview width.

Returns: int -

setWidth(int value)

public final void setWidth(int value)

Page preview width.

Parameters:

Parameter	Type	Description
value	int

getHeight()

public final int getHeight()

Page preview height.

Returns: int -

setHeight(int value)

public final void setHeight(int value)

Page preview height.

Parameters:

Parameter	Type	Description
value	int

getPageNumbers()

public final int[] getPageNumbers()

Page numbers that will be previewed.

Returns: int[] -

setPageNumbers(int[] value)

public final void setPageNumbers(int[] value)

Page numbers that will be previewed.

Parameters:

Parameter	Type	Description
value	int[]

getPreviewFormat()

public final int getPreviewFormat()

Preview image format.

Returns: int -

setPreviewFormat(int value)

public final void setPreviewFormat(int value)

Preview image format.

Parameters:

Parameter	Type	Description
value	int

getResolution()

public int getResolution()

Returns: int

setResolution(int value)

public void setResolution(int value)

Parameters:

Parameter	Type	Description
value	int

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: boolean -

setRenderComments(boolean 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

Parameters:

Parameter	Type	Description
value	boolean

getRenderAnnotations()

public final boolean getRenderAnnotations()

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

Returns: boolean -

setRenderAnnotations(boolean value)

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

getWorksheetColumns()

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> -

getWorksheetColumnsInternal()

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

Returns: com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange>

setWorksheetColumns(List value)

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>

setWorksheetColumnsInternal(System.Collections.Generic.List value)

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>