public class QrCodeSearchOptions extends SearchOptions
Represents abstract search Options for QR-Code signatures.
Constructor and Description |
---|
QrCodeSearchOptions()
Initializes a new instance of the QRCodeSearchOptions class with default values.
|
QrCodeSearchOptions(QrCodeType encodeType)
Initializes a new instance of the QRCodeSearchOptions class with encode type value.
|
QrCodeSearchOptions(QrCodeType encodeType,
String text)
Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.
|
Modifier and Type | Method and Description |
---|---|
IDataEncryption |
getDataEncryption()
Gets or sets implementation of
IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
QrCodeType |
getEncodeType()
Specifies Encode Type property to search QR-Codes.
|
int |
getMatchType()
Gets or sets QR-Code Text Match Type search.
|
boolean |
getReturnContent()
Gets or sets flag to grab QR-Code image content of signature on document page.
|
FileType |
getReturnContentType()
Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
|
String |
getText()
Specifies QR-Code Signature Text if it should be searched and matched.
|
void |
setDataEncryption(IDataEncryption value)
Gets or sets implementation of
IDataEncryption interface to encode and decode QR-Code Signature Text or Data properties. |
void |
setEncodeType(QrCodeType value)
Specifies Encode Type property to search QR-Codes.
|
void |
setMatchType(int value)
Gets or sets QR-Code Text Match Type search.
|
void |
setReturnContent(boolean value)
Gets or sets flag to grab QR-Code image content of signature on document page.
|
void |
setReturnContentType(FileType value)
Specifies file type of returned image content of the QR-Code signature when ReturnContent property is enabled.
|
void |
setText(String value)
Specifies QR-Code Signature Text if it should be searched and matched.
|
getAllPages, getPageNumber, getPagesSetup, getSkipExternal, setAllPages, setPageNumber, setPagesSetup, setSkipExternal, toString
public QrCodeSearchOptions()
Initializes a new instance of the QRCodeSearchOptions class with default values.
public QrCodeSearchOptions(QrCodeType encodeType)
Initializes a new instance of the QRCodeSearchOptions class with encode type value.
encodeType
- Specifies QR-Code encode type.public QrCodeSearchOptions(QrCodeType encodeType, String text)
Initializes a new instance of the QRCodeSearchOptions class with encode type and text values.
encodeType
- Specifies QR-Code encode type.text
- Set Text of QR-Code signature.public final IDataEncryption getDataEncryption()
Gets or sets implementation of IDataEncryption
interface to encode and decode QR-Code Signature Text or Data properties.
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.
public final int getMatchType()
Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.
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.
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.
public final String getText()
Specifies QR-Code Signature Text if it should be searched and matched.
public final void setDataEncryption(IDataEncryption value)
Gets or sets implementation of IDataEncryption
interface to encode and decode QR-Code Signature Text or Data properties.
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.
public final void setMatchType(int value)
Gets or sets QR-Code Text Match Type search. It is used only when Text property is set.
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.
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.
public final void setText(String value)
Specifies QR-Code Signature Text if it should be searched and matched.