OneDBarcodeReadOptions Class | Leadtools.Barcode | Raster, Medical, Document Help

Summary

Contains the extra options to use when reading standard 1D (linear) barcodes.

Syntax

C#

VB

Objective-C

C++

Java

[SerializableAttribute()] 
public class OneDBarcodeReadOptions : BarcodeReadOptions

<TypeConverterAttribute()> 
<SerializableAttribute()> 
Public Class OneDBarcodeReadOptions  
   Inherits BarcodeReadOptions 
   Implements System.ICloneable

@interface LTOneDBarcodeReadOptions : LTBarcodeReadOptions

public class OneDBarcodeReadOptions extends BarcodeReadOptions

[TypeConverterAttribute()] 
[SerializableAttribute()] 
public ref class OneDBarcodeReadOptions : public BarcodeReadOptions, System.ICloneable

Remarks

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:

Member	Description
BarcodeReadOptions.ForeColor	Controls the barcode foreground color (color of the bars or symbols) to use when reading a barcode from a colored image.
BarcodeReadOptions.BackColor	Controls the barcode background color (color of the spaces) to use when reading a barcode from a colored image.
BarcodeReadOptions.Load and BarcodeReadOptions.Save	Can be used to save or load the options to/from an XML file or stream.
BarcodeReadOptions.GetSupportedSymbologies	This class overrides the base class method to return an array containing the following symbologies: BarcodeSymbology.EAN13, BarcodeSymbology.EAN8, BarcodeSymbology.UPCA, BarcodeSymbology.UPCE, BarcodeSymbology.Code3Of9, BarcodeSymbology.Code128, BarcodeSymbology.CodeInterleaved2Of5, BarcodeSymbology.Codabar, BarcodeSymbology.UCCEAN128, BarcodeSymbology.Code93, BarcodeSymbology.EANEXT5, BarcodeSymbology.EANEXT2, BarcodeSymbology.MSI, BarcodeSymbology.Code11, BarcodeSymbology.CodeStandard2Of5, BarcodeSymbology.GS1Databar, BarcodeSymbology.GS1DatabarLimited and BarcodeSymbology.GS1DatabarExpanded

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.

Example

This example shows how to use the OneDBarcodeReadOptions options class to read UPC barcodes from an image.

C#

VB

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; 
 
   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:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Barcode 
Imports Leadtools.ImageProcessing 
 
Public Sub OneDBarcode_Example() 
   Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "MyOneDBarcodes.tif") 
 
   Dim engine As New BarcodeEngine() 
 
   ' Create the image to write the barcodes to 
   Dim resolution As Integer = 300 
   Using image As RasterImage = RasterImage.Create(CType(8.5 * resolution, Integer), CType(11.0 * resolution, Integer), 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 codecs As New RasterCodecs() 
         codecs.Save(image, imageFileName, RasterImageFormat.CcittGroup4, 1) 
      End Using 
   End Using 
 
   ' Now read the barcodes again 
   Using codecs As New RasterCodecs() 
      Using image As RasterImage = 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) 
      End Using 
   End Using 
End Sub 
 
Private Sub WriteBarcode(ByVal writer As BarcodeWriter, ByVal image As RasterImage, ByVal symbology As BarcodeSymbology, ByVal value As String, ByVal bounds As LeadRect) 
   ' Create the barcode data 
   Dim barcode As New BarcodeData(symbology, value) 
   barcode.Bounds = bounds 
 
   ' Set the write options 
   Dim options As 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) 
End Sub 
 
Private Sub ReadBarcodes(ByVal reader As BarcodeReader, ByVal image As RasterImage, ByVal symbology As BarcodeSymbology) 
   ' Setup read options 
   Dim options As 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 
 
   Console.WriteLine("Reading {0} barcodes", symbology) 
   Dim barcode As BarcodeData = reader.ReadBarcode(image, LeadRect.Empty, symbology, options) 
   If Not IsNothing(barcode) Then 
      Console.WriteLine(" At {0}, data: {1}", barcode.Bounds, barcode.Value) 
   Else 
      Console.WriteLine(" Not found") 
   End If 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
using Leadtools.Examples; 
 
public void OneDBarcode_Example(RasterImage image, Stream outStream) 
{ 
   BarcodeEngine engine = new BarcodeEngine(); 
 
   // Create the image to write the barcodes to 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Write a POSTNET and a PLANET barcodes 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.UPCA, "01234567890", new LogicalRectangle(10, 100, 400, 200, LogicalUnit.Pixel)); 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.Code128, "Code 128", new LogicalRectangle(10, 400, 400, 200, LogicalUnit.Pixel)); 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.Code11, "124578", new LogicalRectangle(10, 700, 400, 200, LogicalUnit.Pixel)); 
 
   // Save the image 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1); 
 
   // Now read the barcodes again 
   // 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, LogicalRectangle 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; 
 
   Console.WriteLine("Reading {0} barcodes", symbology); 
   BarcodeData barcode = reader.ReadBarcode(image, LogicalRectangle.Empty, symbology, options); 
   if (barcode != null) 
   { 
      Console.WriteLine(" At {0}, data: {1}", barcode.Bounds, barcode.Value); 
   } 
   else 
   { 
      Console.WriteLine(" Not found"); 
   } 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms 
Imports Leadtools.Barcode 
Imports Leadtools.ImageProcessing 
 
Public Sub OneDBarcode_Example(ByVal image As RasterImage, ByVal outStream As Stream) 
   Dim engine As BarcodeEngine = New BarcodeEngine() 
 
   ' Create the image to write the barcodes to 
   Dim codecs As RasterCodecs = New RasterCodecs() 
 
   ' Write a POSTNET and a PLANET barcodes 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.UPCA, "01234567890", New LogicalRectangle(10, 100, 400, 200, LogicalUnit.Pixel)) 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.Code128, "Code 128", New LogicalRectangle(10, 400, 400, 200, LogicalUnit.Pixel)) 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.Code11, "124578", New LogicalRectangle(10, 700, 400, 200, LogicalUnit.Pixel)) 
 
   ' Save the image 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1) 
 
   ' Now read the barcodes again 
   ' 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) 
End Sub 
 
Private Sub WriteBarcode(ByVal writer As BarcodeWriter, ByVal image As RasterImage, ByVal symbology As BarcodeSymbology, ByVal value As String, ByVal bounds As LogicalRectangle) 
   ' Create the barcode data 
   Dim barcode As BarcodeData = New BarcodeData(symbology, value) 
   barcode.Bounds = bounds 
 
   ' Set the write options 
   Dim options As OneDBarcodeWriteOptions = 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) 
End Sub 
 
Private Sub ReadBarcodes(ByVal reader As BarcodeReader, ByVal image As RasterImage, ByVal symbology As BarcodeSymbology) 
   ' Setup read options 
   Dim options As OneDBarcodeReadOptions = 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 
 
   Console.WriteLine("Reading {0} barcodes", symbology) 
   Dim barcode As BarcodeData = reader.ReadBarcode(image, LogicalRectangle.Empty, symbology, options) 
   If Not barcode Is Nothing Then 
      Console.WriteLine(" At {0}, data: {1}", barcode.Bounds, barcode.Value) 
   Else 
      Console.WriteLine(" Not found") 
   End If 
End Sub