com.groupdocs.annotation.options.pagepreview

Class PreviewOptions



  • public class PreviewOptions
    extends Object

    Represents document preview options.

    • 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:
      • 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:
      • getWidth

        public final int getWidth()

        Page preview width.

        Returns:
      • getWorksheetColumns

        public final List<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> getWorksheetColumns()

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

        Returns:
      • getWorksheetColumnsInternal

        public com.aspose.ms.System.Collections.Generic.List<com.groupdocs.annotation.options.pagepreview.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 -
      • 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 -
      • setWidth

        public final void setWidth(int value)

        Page preview width.

        Parameters:
        value -
      • setWorksheetColumns

        public final void setWorksheetColumns(List<com.groupdocs.annotation.options.pagepreview.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<com.groupdocs.annotation.options.pagepreview.WorksheetColumnsRange> value)