BarcodeRecognitionParams Object (IBarcodeRecognitionParams Interface)

This object provides functionality for tuning parameters of barcode recognition.

A barcode can be highlighted in the Document Definition as a field or as a static element. This depends on the barcode meaning in the documents being processed: if it is intended for Document Definition matching or identification, it is created in the static elements mode (anchor barcode). Meanwhile, if a barcode is intended for data capture, it is created in the field marking mode. The recognition parameters for them are identical except for the Value property which is used only for anchor barcodes.

Recognition parameters of the barcode block in the Document Definition are accessed using the AsBarcodeParams method of the RecognitionParams object of the block.

Properties

Name Type Description
BarcodeParams BarcodeParams

Specifies possible orientation and type of barcode.

Note: The property returns a constant object. To modify the value of the property, you must first receive an intermediate BarcodeParams object with the help of the IEngine::CreateBarcodeParams method, change the necessary parameters, and then assign this object to the property.
ImageProcessingParams ImageProcessingParams

Specifies parameters of image preprocessing inside the barcode block.

Note: The property returns a constant object. To modify the value of the property, you must first receive an intermediate ImageProcessingParams object with the help of the IEngine::CreateImageProcessingParams method, change the necessary parameters, and then assign this object to the property.
IsRequired Boolean If the value of this property is TRUE, the Document Definition will be matched only if the barcode is matched. Set the property to TRUE if there are many very similar Document Definitions in the batch that can be distinguished only by the values of their barcodes. In this case, it will speed up Document Definition selection. Set this property to FALSE if you wish the Document Definition to be matched even if there is no barcode or if it is too faint.
Value String If an anchor barcode is used as an identifier (the IRecognitionParams::IsIdentifier property is set to TRUE), you can specify the value of such identifier. In this case when applying the document definition the program will compare recognized data in the image with the value of the identifier, and the Document Definition matching will be possible only if these values match.

Related objects

Output parameter

This object is the output parameter of the AsBarcodeParams method of the RecognitionParams object.

See also

RecognitionParams

Working with Properties

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.