com.groupdocs.signature.options.search

Class ImageSearchOptions



  • public class ImageSearchOptions
    extends SearchOptions

    Represents search options for Image signatures.

    • Constructor Detail

      • ImageSearchOptions

        public ImageSearchOptions()

        Initializes a new instance of the ImageSearchOptions class with default values.

    • Method Detail

      • getMaxContentSize

        public final long getMaxContentSize()

        For non zero value this flag specifies maximum size of images for search criteria. By default this flag is set to zero and does not affect search result.

      • getMinContentSize

        public final long getMinContentSize()

        For non zero value this flag specifies minimal size of images for search criteria. By default this flag is set to zero and does not affect search result.

      • getReturnContent

        public final boolean getReturnContent()

        Gets or sets flag to grab image content of signature on document page. If this flag is set true, image signature content will keep raw image data by required format ReturnContentType(getReturnContentType()/setReturnContentType(FileType)). By default this option is disabled.

      • getReturnContentType

        public final FileType getReturnContentType()

        Specifies file type of returned content of the image signature when ReturnContent property is enabled. By default it set to Null. That means to return image content in original format. This image format is specified at ImageSignature.Format Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than image content in original format will be returned.

      • setMaxContentSize

        public final void setMaxContentSize(long value)

        For non zero value this flag specifies maximum size of images for search criteria. By default this flag is set to zero and does not affect search result.

      • setMinContentSize

        public final void setMinContentSize(long value)

        For non zero value this flag specifies minimal size of images for search criteria. By default this flag is set to zero and does not affect search result.

      • setReturnContent

        public final void setReturnContent(boolean value)

        Gets or sets flag to grab image content of signature on document page. If this flag is set true, image signature content will keep raw image data by required format ReturnContentType(getReturnContentType()/setReturnContentType(FileType)). By default this option is disabled.

      • setReturnContentType

        public final void setReturnContentType(FileType value)

        Specifies file type of returned content of the image signature when ReturnContent property is enabled. By default it set to Null. That means to return image content in original format. This image format is specified at ImageSignature.Format Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than image content in original format will be returned.