[SerializableAttribute()]
public class OneDBarcodeReadOptions : BarcodeReadOptions
The OneDBarcodeReadOptions class is used to control the options when reading standard 1D (linear) barcodes using LEADTOOLS. Set the options in two ways:
The BarcodeReader class contains default options for each barcode symbology (or group of common symbologies). These options can be retrieved using the BarcodeReader.GetDefaultOptions method passing one of the following:
Change the members of the returned OneDBarcodeReadOptions by casting it from BarcodeReadOptions to OneDBarcodeReadOptions.
You can also create an instance of the OneDBarcodeReadOptions class and use it directly in the BarcodeReader.ReadBarcode and BarcodeReader.ReadBarcodes methods that accept a single array of options as an input parameter.
The base BarcodeReadOptions contains the following members and features:
In addition to the features and members, OneDBarcodeReadOptions contains these standard 1D (linear) barcodes specific features:
Member | Description |
---|---|
SearchDirection |
The direction to use when searching for barcodes (horizontal, vertical or both) |
EnableFastMode |
Fast barcode reading (recommended). It is suitable for most barcode qualities either good or poor |
Granularity |
The number of scanned lines per column to skip when reading a barcode |
MinimumStringLength |
The minimum string length to use when searching for a non-fixed length barcode. |
MaximumStringLength |
The maximum string length to use when searching for a non-fixed length barcode. |
WhiteLinesNumber |
The minimum number of lines of white space above and below the barcode symbol. |
EnableDoublePass |
Enable internal auto pre-processing of the image data if no barcode was found. |
EnablePreprocessing |
Enable applying auto segmentation and deep auto pre-processing to the image then re-scanning if no barcodes of this symbology are found. |
ReturnCheckDigit |
The error check digit is returned as part of the barcode data |
EnableErrorCheck |
The optional check word is used for validity check when reading a barcode (if supported). |
AvoidCorruptedBlocks |
Avoids corrupted blocks when reading barcodes. |
AllowPartialRead |
Allows returning partially read barcodes. |
ResizeSmall1D |
Enhance the bars for the small module width symbols. |
Code11CheckDigitType |
Checks digit type to use when reading Code 11 (USD-8) barcodes. |
MSIModuloType |
Checks digit type to use when reading MSI (Pulse Width Modulated) barcodes. |
Code39Extended |
Allows decoding extended characters when reading Code 3 of 9 symbols. |
CalculateBarWidthReduction |
Allows calculating the bar width reduction value. |
This example shows how to use the OneDBarcodeReadOptions options class to read UPC barcodes from an image.
using Leadtools;
using Leadtools.Codecs;
using Leadtools.Barcode;
using Leadtools.ImageProcessing;
public void OneDBarcode_Example()
{
string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyOneDBarcodes.tif");
BarcodeEngine engine = new BarcodeEngine();
// Create the image to write the barcodes to
int resolution = 300;
using (RasterImage image = RasterImage.Create((int)(8.5 * resolution), (int)(11.0 * resolution), 1, resolution, RasterColor.FromKnownColor(RasterKnownColor.White)))
{
// Write a POSTNET and a PLANET barcodes
WriteBarcode(engine.Writer, image, BarcodeSymbology.UPCA, "01234567890", new LeadRect(10, 100, 400, 200));
WriteBarcode(engine.Writer, image, BarcodeSymbology.Code128, "Code 128", new LeadRect(10, 400, 400, 200));
WriteBarcode(engine.Writer, image, BarcodeSymbology.Code11, "124578", new LeadRect(10, 700, 400, 200));
// Save the image
using (RasterCodecs codecs = new RasterCodecs())
{
codecs.Save(image, imageFileName, RasterImageFormat.CcittGroup4, 1);
}
}
// Now read the barcodes again
using (RasterCodecs codecs = new RasterCodecs())
{
using (RasterImage image = codecs.Load(imageFileName))
{
// Read the UPC-A barcode
ReadBarcodes(engine.Reader, image, BarcodeSymbology.UPCA);
// Read the Code 128 barcode
ReadBarcodes(engine.Reader, image, BarcodeSymbology.Code128);
// Read the Code 11 barcode
ReadBarcodes(engine.Reader, image, BarcodeSymbology.Code11);
}
}
}
private void WriteBarcode(BarcodeWriter writer, RasterImage image, BarcodeSymbology symbology, string value, LeadRect bounds)
{
// Create the barcode data
BarcodeData barcode = new BarcodeData(symbology, value);
barcode.Bounds = bounds;
// Set the write options
OneDBarcodeWriteOptions options = new OneDBarcodeWriteOptions();
options.TextPosition = BarcodeOutputTextPosition.Default;
options.UseXModule = false;
options.XModule = 30;
options.EnableErrorCheck = false;
options.SetGS1DatabarLinkageBit = false;
options.WriteTruncatedGS1Databar = false;
options.Code128TableEncoding = Code128BarcodeTableEncoding.Auto;
options.Code11CheckDigitType = Code11BarcodeCheckDigitType.CDigit;
options.MSIModuloType = MSIBarcodeModuloType.Modulo10;
// Write it
Console.WriteLine("Writing {0} barcode with data: {1}", symbology, value);
writer.WriteBarcode(image, barcode, options);
}
private void ReadBarcodes(BarcodeReader reader, RasterImage image, BarcodeSymbology symbology)
{
// Setup read options
OneDBarcodeReadOptions options = new OneDBarcodeReadOptions();
options.SearchDirection = BarcodeSearchDirection.Horizontal;
options.EnableFastMode = true;
options.Granularity = 9;
options.MinimumStringLength = 3;
options.MaximumStringLength = 0;
options.WhiteLinesNumber = 3;
options.ReturnCheckDigit = BarcodeReturnCheckDigit.Default;
options.EnableErrorCheck = false;
options.AvoidCorruptedBlocks = false;
options.AllowPartialRead = false;
options.Code11CheckDigitType = Code11BarcodeCheckDigitType.CDigit;
options.MSIModuloType = MSIBarcodeModuloType.Modulo10;
options.CalculateBarWidthReduction = true;
options.Code39Extended = false;
options.EnableDoublePass = false;
options.EnablePreprocessing = false;
options.ResizeSmall1D = false;
Console.WriteLine("Reading {0} barcodes", symbology);
BarcodeData barcode = reader.ReadBarcode(image, LeadRect.Empty, symbology, options);
if (barcode != null)
{
Console.WriteLine(" At {0}, data: {1}", barcode.Bounds, barcode.Value);
}
else
{
Console.WriteLine(" Not found");
}
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images";
}