Detects and reads barcode data. When run on an object from the batch viewer or a batch process, detected barcode information is stored as part of the object's layout data.
| Property Name |
Property Type |
Description |
| AdvancedCode39 |
Grooper.IP.Code39 |
Enables or disables advanced Code 39 detection. |
| BinarizationSettings |
Grooper.IP.Binarize |
Specifies binarization settings to be used for converting color and grayscale images to black white. |
| Code39Settings |
Grooper.IP.ReadBarcodes.Code39Options |
Options specific to Code39 barcode reading.A combination of the following flags:
- None: No options set.
- DontRequireStartStop: If this flag is set, start/stop characters are not required in Code 39 barcodes. This may produce false positives when reading barcodes.
- DisableFullASCII: If this flag is set, escape codes that enable full ASCII encoding in Code 39 barcodes will be disabled.
|
| CommandTypeName |
System.String |
The type of IP command. |
| Direction |
Grooper.IP.ReadBarcodes.ReadDirection |
Determines in which direction(s) the barcode reader searches the document for recognizable barcodes. South, for example, starts at the top of the page and reads down. Multiple directions can be useful for
detecting barcodes with inconsistent orientations. However, certain barcode values may change if they are read upside down. For example: A Patch T
barcode read upside down becomes a Patch 3.A combination of the following flags:
- None: Represents no directions. Not recommended in general use.
- East: Easterly scan (horizontally, left to right).
- South: Southerly scan (vertically, top to bottom).
- West: Westerly scan (horizontally, right to left).
- North: Northerly scan (vertically, bottom to top).
- NorthEast: Northeasterly scan (diagonally, lower left to upper right).
- SouthEast: Southeasterly scan (diagonally, upper right to lower left).
- SouthWest: Southwesterly scan (diagonally, upper right to lower left).
- NorthWest: Northwesterly scan (diagonally, lower right to upper left).
- All: Represents all supported directions.
|
| EnforceChecksum |
System.Boolean |
Sets whether or not checksum values are enforced. If set to false, any checksum character is just a character in the encodation string.
Symbologies in which a checksum character is optional:
- Code 11 - first 'C' checksum always enforced, second 'K' checksum optional.
- Code 39 and Code 93 - 2 check characters.
- Interleaved 2 of 5
|
| HasReferenceProperties |
System.Boolean |
Returns true if the object has properties which reference Grooper Node objects. |
| IsEmpty |
System.Boolean |
Returns true if all properties with a ViewableAttribute are set to their default value. |
| IsWriteable |
System.Boolean |
Returns true if the object is writable, or false if it is not. |
| Owner |
Grooper.ConnectedObject |
Returns the node that owns the connected object, if any. |
| OwnerNode |
Grooper.GrooperNode |
Returns the node that owns the connected object, if any. |
| Pdf417Settings |
Grooper.IP.ReadBarcodes.Pdf417Options |
Options specific to PDF417 barcode reading.A combination of the following flags:
- None: No options set.
- ReadTruncated: Indicates whether or not the parser should also search for truncated PDF 417. A truncated PDF417 symbol uses less area than the normal
PDF417 barcode by elminating the right hand side of the symbol.
- EnahancedBoundaryLocation: Indicates whether or not the PDF417 parser should enable an additional routine to help it find the locations and boundaries of
individual blocks/strips within the barcode more accurately.
- OutputHeader: Indicates whether or not the PDF417 parser should output data from the Macro PDF417 header at the end of the barcode, should one be found.
|
| Quality |
Grooper.IP.ReadBarcodes.ReadingQuality |
This setting has high-level influence over performance and accuracy of barcode recognition.Can be one of the following values:
- Normal: Uses normal barcode extraction.
- MostAccurate: This will cause a fine-grained scanning for barcode features, repeating the search multiple times using different settings.
- Fastest: Coarse scanning of the document for barcode features. More likely to give up earlier without finding all barcodes.
|
| QuietZoneTolerance |
System.Double |
Barcodes require an area of free space around the barcode known as the Quiet Zone. These areas should be clear of any stray marks or graphics.
Quiet Zone Tolerance defines how tolerant the barcode reader is of marks in the
Quiet Zone. A setting of 0% will ignore the Quiet Zone requirement. A setting
of 100% will strictly require that the Quiet Zone is respected. Settings closer
to 100% can be good for barcodes like patch codes that are generally unobstructed.
Settings closer to 0% can cause false positives, but may be required for barcodes
that are embedded in the content of a document (e.g. Code39 or UPC). |
| RegionOfInterest |
Grooper.IP.LogicalRectangle |
Defines an optional region of interest for the barcode reading operation. If a region is specified, only barcode fully enclosed by the region will be recognized. |
| Root |
Grooper.GrooperRoot |
Returns the root node |
| ScanBarsToRead |
System.Int32 |
The maximum number of barcodes to read. |
| ScanInterval |
System.Int32 |
This can be used to set the number of lines that are read per scan, when attempting to find a bar code. Setting the scan interval to 1 will read every line of the image. Setting this to 10 will scan every 10th line of the image. The lower the number the more accurate, however this will take longer to run. |
| SkipAllValidation |
System.Boolean |
This property is useful for reading barcodes that are damaged or malformed. However, barcodes read while this property is set to true may
not be as reliable (i.e. false positives are more likely). |
| SupportedFormats |
System.String |
The pixel formats supported by this command. |
| SupportedPixelFormats |
System.Collections.Generic.IEnumerable(Of T) |
Returns a list of supported pixel formats of images that can be processed by the IP Command. |
| Symbology |
Grooper.IP.ReadBarcodes.BarcodeType |
Barcode symbologies to read.A combination of the following flags:
- None: No symbology.
- AustraliaPost: Australia Post 4-state barcode.
- Codabar: Codabar is a linear barcode symbology developed in 1972 by Pitney Bowes Corp It and its variants are also known as
Codeabar, Ames Code, NW-7, Monarch, Code 2 of 7, Rationalized Codabar, ANSI/AIM BC3-1995 or USD-4.
- Code11: Code 11 is a barcode symbology developed by Intermec in 1977. It is used primarily in telecommunications.
The symbol can encode any length string consisting of the digits 0-9 and the dash character (-). One or two modulo-11 check digit(s) can be included.
- Code128: Code 128 is a high-density barcode symbology used for alphanumeric or numeric-only barcodes. It can encode all 128 characters of
ASCII and, by use of an extension character (FNC4), the Latin-1 characters defined in ISO/IEC 8859-1.
- Code32: Also known as Italian Pharmacode, IMH, Codice 32 Pharmacode, Codice Farmaceutico Italiano, Radix 32 Barcode.
- Code39: Code 39 is a commonly used variable length alphanumeric barcode symbology. Also known as Alpha39, Code 3 of 9, Code 3/9, Type 39, USS Code 39, or USD-3.
- Code93: Code 93 is a barcode symbology designed in 1982 by Intermec to provide a higher density and data security enhancement to Code 39. It is an alphanumeric,
variable length symbology. Code 93 is used primarily by Canada Post to encode supplementary delivery information. Every symbol includes two check characters.
- Datamatrix: A Data Matrix code is a two-dimensional matrix barcode consisting of black and white "cells" or modules arranged in either a square or rectangular pattern.
The information to be encoded can be text or numeric data. Usual data size is from a few bytes up to 1556 bytes
- Ean13: An EAN-13 barcode (originally European Article Number, but now renamed International Article Number even though the abbreviation EAN has been retained)
is a 13 digit (12 data and 1 check) barcoding standard which is a superset of the original 12-digit Universal Product Code (UPC) system developed in 1970 by
George J. Laurer. The EAN-13 barcode is defined by the standards organization GS1.
- Ean8: An EAN-8 is a barcode and is derived from the longer European Article Number (EAN-13) code. It was introduced for use on small
packages where an EAN-13 barcode would be too large.
- I2of5: Interleaved 2 of 5 (ITF, from Interleaved Two of Five) is a continuous two-width barcode symbology encoding digits. It is used commercially on 135 film,
for ITF-14 barcodes, and on cartons of some products, while the products inside are labeled with UPC or EAN.
- IntelligentMail: The Intelligent Mail Barcode (IM barcode) is a 65-bar code for use on mail in the United States. The term “Intelligent Mail” refers to services offered
by the United States Postal Service for domestic mail delivery. The IM barcode is intended to provide greater information and functionality than its predecessors
POSTNET and PLANET. An Intelligent Mail barcode has also been referred to as a One Code Solution and a 4-State Customer Barcode, abbreviated 4CB, 4-CB or USPS4CB.
- Itf14: ITF-14 (Interleaved Two of Five) is the GS1 implementation of an Interleaved 2 of 5 bar code to encode a Global Trade Item Number. ITF-14 symbols are generally used
on packaging levels of a product, such as a case box of 24 cans of soup. The ITF-14 will always encode 14 digits.
- MicroQr: Micro QR code is a smaller version of the QR code standard for applications where symbol size is limited.
- Patch: Detects Patch 1, Patch 2, Patch 3, Patch 4, Patch 6, and Patch T patch code scanner sheets. The detected
patch code symbology is returned as the barcode value.
- Pdf417: PDF417 is a 2D (stacked linear) barcode symbology used in a variety of applications, primarily transport, identification cards, and inventory management.
PDF417 is one of the formats (along with Data Matrix) that can be used to print postage accepted by the United States Postal Service. PDF417 is also selected by
the airline industry's Bar Coded Boarding Pass standard (BCBP) as the 2D bar code symbolism for paper boarding passes. PDF417 is the standard selected by the
Department of Homeland Security as the machine readable zone technology for RealID compliant driver licenses and state issued identification cards. It is also used on
FedEx on package labels.
- Planet: The Postal Alpha Numeric Encoding Technique (PLANET) barcode was used by the United States Postal Service to identify and track pieces of mail during delivery -
the Post Office's "CONFIRM" services. It was fully superseded by Intelligent Mail Barcode by January 28, 2013.
- Postnet: POSTNET (Postal Numeric Encoding Technique) is a barcode symbology used by the United States Postal Service to assist in directing mail.
- Plus2: 2-digit supplementals associated with EAN and UPC symbology barcodes.
- Plus5: 5-digit supplementals associated with EAN and UPC symbology barcodes.
- Qr: QR code (abbreviated from Quick Response Code) is the trademark for a type of matrix barcode (or two-dimensional barcode) first designed for the automotive industry in Japan.
The QR Code system became popular outside the automotive industry due to its fast readability and greater storage capacity compared to standard UPC barcodes. Applications include
product tracking, item identification, time tracking, document management, and general marketing.
- Rm4scc: Royal Mail 4-State Customer Code is a barcode symbology used by the Royal Mail for its Cleanmail service.
- Rss14: RSS 14 barcode (Reduce Space Symbology) encodes the full 14-digit EAN.UCC item identification in a symbol that can be omnidirectionally
scanned by suitably configured point-of-sale laser scanners. RSS-14 alternate formats are read as well as the regular format. The alternate
formats are truncated, stacked, and stacked omnidirectional. It is recommended that the alignment of truncated and stacked symbols be close to horizontal or vertical.
- RssLimited: RSS Limited encodes a 14-digit EAN.UCC item identification with indicator digits of 0 or 1 in a small symbol which will not be scanned at POS.
It is recommended that symbols whose height is near to the specified minimum be aligned close to horizontal or vertical.
- Telepen: Telepen is a name of a barcode symbology designed in 1972 in the UK to express all 128 ASCII characters.
- Upca: UPC-A. The Universal Product Code (UPC) is a barcode symbology widely used in the United States, Canada, the United Kingdom, Australia, New Zealand, and in other
countries for tracking trade items in stores. The most common form, UPC-A, consists of 12 numerical digits, which are uniquely assigned to each trade item.
- Upce: UPC-E. This symbology differs from UPC-A in that it only uses a 6-digit code. To allow the use of UPC barcodes on smaller packages where a full 12-digit
barcode may not fit, a 'zero-suppressed' version of UPC was developed called UPC-E, in which the number system digit and all trailing zeros in the manufacturer
code and all leading zeros in the product code are suppressed. Encodations are a compressed form of UPC A. The DataString property holds the full uncompressed
UPC A encodation for this symbology.
- Aztec: Aztec is public domain 2D barcode symbology, formally defined by the ISO/IEC 24778:2008 standard
- All: Read all barcode formats.
|
| Method Name |
Description |
| Apply(Image As GrooperImage, DiagMode As Boolean) As IpCommandResult |
| Parameters |
| Image |
| Type: GrooperImage |
| |
| |
| DiagMode |
| Type: Boolean |
| |
|
| ApplyAtalaCommand(cmd As ImageCommand, Image As GrooperImage) As AtalaIpResult |
| Parameters |
| cmd |
| Type: ImageCommand |
| |
| |
| Image |
| Type: GrooperImage |
| |
|
| ApplyCommand(Image As GrooperImage) As IpCommandResult |
| Parameters |
| Image |
| Type: GrooperImage |
| |
|
| ApplyImage(Image As GrooperImage) As GrooperImage |
| Parameters |
| Image |
| Type: GrooperImage |
| |
|
| GetProperties() As PropertyDescriptorCollection |
|
| GetReferences() As List(Of GrooperNode) |
Returns a list of GrooperNode objects referenced in the properties of this object. |
| IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently enabled.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the enabled state for. |
|
| IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently visible.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the visible state for. |
|
| IsType(Type As Type) As Boolean |
Returns true if the object is of the type specified, or if it derives from the type specfied.
| Parameters |
| Type |
| Type: Type |
| The type to check. |
|
| Serialize() As String |
Serializes the object. |
| SetDatabase(Database As GrooperDb) |
Sets the database connection of the object.
| Parameters |
| Database |
| Type: GrooperDb |
| |
|
| SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) |
Sets the owner of the connected object with another object that implements the IConnected interface.
| Parameters |
| Owner |
| Type: ConnectedObject |
| |
| |
| SkipInitialization |
| Type: Boolean |
| |
|
| ToString() As String |
Returns a string value representation of the connected object. |
| ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |