BarcodeSearchOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.signature.options.OptionsExtensions, com.groupdocs.signature.options.search.SearchOptions
public class BarcodeSearchOptions extends SearchOptions
Represents abstract search Options for Barcode signatures.
| Constructor | Description |
|---|---|
| BarcodeSearchOptions() | Initializes a new instance of the SearchBarcodeOptions class with default values. |
| BarcodeSearchOptions(BarcodeType encodeType) | Initializes a new instance of the SearchBarcodeOptions class with encode type value. |
| BarcodeSearchOptions(BarcodeType encodeType, String text) | Initializes a new instance of the SearchBarcodeOptions class with encode type and text values. |
| Method | Description |
|---|---|
| getEncodeType() | Specifies Encode Type property to search Barcodes. |
| setEncodeType(BarcodeType value) | Specifies Encode Type property to search Barcodes. |
| getText() | Specifies Barcode Signature text if it should be searched and matched. |
| setText(String value) | Specifies Barcode Signature text if it should be searched and matched. |
| getMatchType() | Gets or sets Barcode text Match Type search. |
| setMatchType(int value) | Gets or sets Barcode text Match Type search. |
| getReturnContent() | Gets or sets flag to grab Barcode image content of signature on document page. |
| setReturnContent(boolean value) | Gets or sets flag to grab Barcode image content of signature on document page. |
| getReturnContentType() | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
| setReturnContentType(FileType value) | Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. |
public BarcodeSearchOptions()
Initializes a new instance of the SearchBarcodeOptions class with default values.
public BarcodeSearchOptions(BarcodeType encodeType)
Initializes a new instance of the SearchBarcodeOptions class with encode type value.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| encodeType | BarcodeType | Specifies Barcode encode type. |
public BarcodeSearchOptions(BarcodeType encodeType, String text)
Initializes a new instance of the SearchBarcodeOptions class with encode type and text values.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| encodeType | BarcodeType | Specifies Barcode encode type. |
| text | java.lang.String | Set Text of Barcode signature. |
public final BarcodeType getEncodeType()
Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types
Returns: BarcodeType
public final void setEncodeType(BarcodeType value)
Specifies Encode Type property to search Barcodes. If this value is not set, search is processed for all supported Barcode Types
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | BarcodeType |
public final String getText()
Specifies Barcode Signature text if it should be searched and matched.
Returns: java.lang.String
public final void setText(String value)
Specifies Barcode Signature text if it should be searched and matched.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
public final int getMatchType()
Gets or sets Barcode text Match Type search. It is used only when Text property is set.
Returns: int
public final void setMatchType(int value)
Gets or sets Barcode text Match Type search. It is used only when Text property is set.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final boolean getReturnContent()
Gets or sets flag to grab Barcode image content of signature on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format ReturnContentType (#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.
Returns: boolean
public final void setReturnContent(boolean value)
Gets or sets flag to grab Barcode image content of signature on document page. If this flag is set true, Barcode signature image content will keep raw image data by required format ReturnContentType (#getReturnContentType.getReturnContentType/#setReturnContentType(FileType).setReturnContentType(FileType)). By default this option is disabled.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
public final FileType getReturnContentType()
Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at BarcodeSignature.Format (BarcodeSignature.getFormat}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.
Returns: FileType
public final void setReturnContentType(FileType value)
Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled. By default it set to Null. That means to return Barcode image content in original format. This image format is specified at BarcodeSignature.Format (BarcodeSignature.getFormat}) Possible supported values are: FileType.JPEG, FileType.PNG, FileType.BMP. If provided format is not supported than Barcode image content in .png format will be returned.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | FileType |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.