com.groupdocs.signature.options.search

Class QrCodeSearchOptions



  • public class QrCodeSearchOptions
    extends SearchOptions

    Represents abstract search Options for QR-Code signatures.

    • Constructor Detail

      • QrCodeSearchOptions

        public QrCodeSearchOptions()

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

      • QrCodeSearchOptions

        public QrCodeSearchOptions(QrCodeType encodeType)

        Initializes a new instance of the QRCodeSearchOptions class with encode type value.

        Parameters:
        encodeType - Specifies QR-Code encode type.
      • QrCodeSearchOptions

        public QrCodeSearchOptions(QrCodeType encodeType,
                           String text)

        Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.

        Parameters:
        encodeType - Specifies QR-Code encode type.
        text - Set Text of QR-Code signature.
    • Method Detail

      • getDataEncryption

        public final IDataEncryption getDataEncryption()

        Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

      • getEncodeType

        public final QrCodeType getEncodeType()

        Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

      • getMatchType

        public final int getMatchType()

        Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

      • getReturnContent

        public final boolean getReturnContent()

        Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image 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 image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at QrCodeSignature.Format() Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned.

      • getText

        public final String getText()

        Specifies QR-Code Signature Text if it should be searched and matched.

      • setDataEncryption

        public final void setDataEncryption(IDataEncryption value)

        Gets or sets implementation of IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties.

      • setEncodeType

        public final void setEncodeType(QrCodeType value)

        Specifies Encode Type property to search QR-Codes. If this value is not set, search is processed for all supported QR-Code Types.

      • setMatchType

        public final void setMatchType(int value)

        Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.

      • setReturnContent

        public final void setReturnContent(boolean value)

        Gets or sets flag to grab QR-Code image content of signature on document page. If this flag is set true, QR-Code signature image 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 image content of the QR-Code signature when ReturnContent property is enabled. By default it set to Null. That means to return QR-Code image content in original format. This image format is specified at QrCodeSignature.Format() Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than QR-Code image content in original .png will be returned.

      • setText

        public final void setText(String value)

        Specifies QR-Code Signature Text if it should be searched and matched.