Skip navigation links
com.groupdocs.viewer.options

Class PdfViewOptions


  • public class PdfViewOptions
extends ViewOptions

    Provides options for rendering documents into PDF format.

    • Constructor Detail

      • PdfViewOptions

        public PdfViewOptions()

        Initializes new instance of PdfViewOptions class.

        This constructor initializes new instance of PdfViewOptions with "output.pdf" as file path format for the output file. The output file will be placed into current working directory of the application.

      • PdfViewOptions

        public PdfViewOptions(CreateFileStream createFileStream)
        Initializes new instance of PdfViewOptions class.
        Parameters:
        createFileStream - The method that instantiates stream used to write output file data.

      • PdfViewOptions

        public PdfViewOptions(CreateFileStream createFileStream,
                      ReleaseFileStream releaseFileStream)
        Initializes new instance of PdfViewOptions class.
        Parameters:
        createFileStream - The method that instantiates stream used to write output file data.
        releaseFileStream - The method that releases stream created by method assigned to delegate that passed to createFileStream parameter.

      • PdfViewOptions

        public PdfViewOptions(FileStreamFactory fileStreamFactory)

        Initializes new instance of PdfViewOptions class.

        Parameters:
        fileStreamFactory - The factory which implements methods for creating and releasing output file stream.
        Throws:
        IllegalArgumentException - Thrown when fileStreamFactory is null.

      • PdfViewOptions

        public PdfViewOptions(String outputFilePath)

        Initializes new instance of PdfViewOptions class.

        Parameters:
        outputFilePath - The path for output PDF file.
        Throws:
        IllegalArgumentException - Thrown when outputFilePath is null or empty.

    • Method Detail

      • getImageHeight

        public int getImageHeight()
        The height of an output image in pixels. (When converting single image to HTML only)

      • getImageMaxHeight

        public int getImageMaxHeight()
        Max height of an output image in pixels. (When converting single image to HTML only)

      • getImageMaxWidth

        public int getImageMaxWidth()
        Max width of an output image in pixels. (When converting single image to HTML only)

      • getImageWidth

        public int getImageWidth()
        The width of the output image in pixels. (When converting single image to HTML only)

      • getJpgQuality

        public final int getJpgQuality()

        The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90.

      • getSecurity

        public final Security getSecurity()

        The output PDF document security options.

      • setImageHeight

        public void setImageHeight(int imageHeight)
        The height of an output image in pixels. (When converting single image to HTML only)

      • setImageMaxHeight

        public void setImageMaxHeight(int imageMaxHeight)
        Max height of an output image in pixels. (When converting single image to HTML only)

      • setImageMaxWidth

        public void setImageMaxWidth(int imageMaxWidth)
        Max width of an output image in pixels. (When converting single image to HTML only)

      • setImageWidth

        public void setImageWidth(int imageWidth)
        The width of the output image in pixels. (When converting single image to HTML only)

      • setJpgQuality

        public final void setJpgQuality(int value)

        The quality of the JPG images contained by output PDF document; Valid values are between 1 and 100; Default value is 90.

      • setSecurity

        public final void setSecurity(Security value)

        The output PDF document security options.