com.groupdocs.signature.options.search

Class BarcodeSearchOptions

java.lang.Object

com.groupdocs.signature.options.OptionsExtensions

com.groupdocs.signature.options.search.SearchOptions

com.groupdocs.signature.options.search.BarcodeSearchOptions

public class BarcodeSearchOptions
extends SearchOptions

Represents abstract search Options for Barcode signatures.

Constructor Summary

Constructors

Constructor and 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 Summary

Modifier and Type	Method and Description
BarcodeType	getEncodeType() Specifies Encode Type property to search Barcodes.
int	getMatchType() Gets or sets Barcode text Match Type search.
boolean	getReturnContent() Gets or sets flag to grab Barcode image content of signature on document page.
FileType	getReturnContentType() Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
String	getText() Specifies Barcode Signature text if it should be searched and matched.
void	setEncodeType(BarcodeType value) Specifies Encode Type property to search Barcodes.
void	setMatchType(int value) Gets or sets Barcode text Match Type search.
void	setReturnContent(boolean value) Gets or sets flag to grab Barcode image content of signature on document page.
void	setReturnContentType(FileType value) Specifies file type of returned image content of the Barcode signature when ReturnContent property is enabled.
void	setText(String value) Specifies Barcode Signature text if it should be searched and matched.

Methods inherited from class com.groupdocs.signature.options.search.SearchOptions

getAllPages, getPageNumber, getPagesSetup, getSearchPages, getSkipExternal, setAllPages, setPageNumber, setPagesSetup, setSkipExternal, toString

Methods inherited from class com.groupdocs.signature.options.OptionsExtensions

typeName, typeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BarcodeSearchOptions

public BarcodeSearchOptions()

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

BarcodeSearchOptions

public BarcodeSearchOptions(BarcodeType encodeType)

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

Parameters:

encodeType - Specifies Barcode encode type.

BarcodeSearchOptions

public BarcodeSearchOptions(BarcodeType encodeType,
                            String text)

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

Parameters:

encodeType - Specifies Barcode encode type.

text - Set Text of Barcode signature.

Method Detail

getEncodeType

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

getMatchType

public final int getMatchType()

Gets or sets Barcode text Match Type search. It is used only when Text property is set.

getReturnContent

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()/setReturnContentType(FileType)). By default this option is disabled.

getReturnContentType

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.

getText

public final String getText()

Specifies Barcode Signature text if it should be searched and matched.

setEncodeType

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

setMatchType

public final void setMatchType(int value)

Gets or sets Barcode 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 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()/setReturnContentType(FileType)). By default this option is disabled.

setReturnContentType

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.

setText

public final void setText(String value)

Specifies Barcode Signature text if it should be searched and matched.