com.groupdocs.signature.options

Class PreviewOptions



  • public class PreviewOptions
    extends Object

    Represents document preview options.

    • Constructor Detail

      • PreviewOptions

        public PreviewOptions(PageStreamFactory pageStreamFactory,
                      int... pageNumbers)

        Initializes PreviewOptions object.

        Parameters:
        pageStreamFactory - Interface which defines method to create output page preview stream.
        pageNumbers - Desired page numbers
      • PreviewOptions

        public PreviewOptions(String filePathFormat,
                      int... pageNumbers)

        Initializes PreviewOptions object.

        Parameters:
        filePathFormat - Path to output file.
        pageNumbers - Desired page numbers
    • Method Detail

      • getHeight

        public final int getHeight()

        Gets or sets preview images height.

      • getHideSignatures

        public final boolean getHideSignatures()

        Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.

      • getPageNumbers

        public final int[] getPageNumbers()

        Gets or sets preview images page numbers.

      • getPreviewFormat

        public final int getPreviewFormat()

        Gets or sets preview images format.

      • getWidth

        public final int getWidth()

        Gets or sets preview images width.

      • setHeight

        public final void setHeight(int value)

        Gets or sets preview images height.

      • setHideSignatures

        public final void setHideSignatures(boolean value)

        Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.

      • setPageNumbers

        public final void setPageNumbers(int[] value)

        Gets or sets preview images page numbers.

      • setPreviewFormat

        public final void setPreviewFormat(int value)

        Gets or sets preview images format.

      • setWidth

        public final void setWidth(int value)

        Gets or sets preview images width.