FourStateBarcodeReadOptions Class

Summary

Contains the extra options to use when reading 4-State post barcodes such as USPS, Royal Mail and Australian Post.

Syntax

Objective-C

C++

Java

[SerializableAttribute()] 
public class FourStateBarcodeReadOptions : BarcodeReadOptions

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

@interface LTFourStateBarcodeReadOptions : LTBarcodeReadOptions

public class FourStateBarcodeReadOptions extends BarcodeReadOptions

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

Remarks

The FourStateBarcodeReadOptions class is used to control the options when reading 4-State post 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 FourStateBarcodeReadOptions class by casting it from BarcodeReadOptions to FourStateBarcodeReadOptions.

Create an instance of FourStateBarcodeReadOptions class and use it directly in the BarcodeReader.ReadBarcode and BarcodeReader.ReadBarcodes methods that accept a single or 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.USPS4State, BarcodeSymbology.AustralianPost4State and BarcodeSymbology.RoyalMail4State

In addition to these features and members, the FourStateBarcodeReadOptions contains these 4-State post barcodes specific features:

Member	Description
SearchDirection	The direction to use when searching for barcodes (horizontal, vertical or both)
Granularity	The number of scanned lines per column to skip when reading a barcode
ReturnCheckDigit	The error check digit is returned as part of the barcode data
AustralianPostCIFEncoding	Australian Post Customer Information Field (CIF) Decoding table

Example

This example writes a few 4-State barcodes with different options to an image and then reads them back.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
 
public void FourStateBarcode_Example() 
{ 
   string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyFourStateBarcodes.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 few Four-State barcodes, a USPS, Royal Mail and Australian Post 
      WriteBarcode(engine.Writer, image, BarcodeSymbology.USPS4State, "0123456709498765432101234567891", new LeadRect(10, 100, 400, 200)); 
      WriteBarcode(engine.Writer, image, BarcodeSymbology.RoyalMail4State, "123456789", new LeadRect(10, 500, 400, 200)); 
      WriteBarcode(engine.Writer, image, BarcodeSymbology.AustralianPost4State, "11-12345678", new LeadRect(10, 900, 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 USPS barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.USPS4State); 
 
         // Read the Royal Mail barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.RoyalMail4State); 
 
         // Read the Australian Post barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.AustralianPost4State); 
      } 
   } 
} 
 
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 
   FourStateBarcodeWriteOptions options = new FourStateBarcodeWriteOptions(); 
   options.TextPosition = BarcodeOutputTextPosition.Default; 
   options.XModule = 30; 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable; 
 
   // 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 
   FourStateBarcodeReadOptions options = new FourStateBarcodeReadOptions(); 
   options.SearchDirection = BarcodeSearchDirection.Horizontal; 
   options.Granularity = 9; 
   options.ReturnCheckDigit = BarcodeReturnCheckDigit.Default; 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable; 
 
   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 FourStateBarcode_Example() 
   Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "MyFourStateBarcodes.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 few Four-State barcodes, a USPS, Royal Mail and Australian Post 
      WriteBarcode(engine.Writer, image, BarcodeSymbology.USPS4State, "0123456709498765432101234567891", New LeadRect(10, 100, 400, 200)) 
      WriteBarcode(engine.Writer, image, BarcodeSymbology.RoyalMail4State, "123456789", New LeadRect(10, 500, 400, 200)) 
      WriteBarcode(engine.Writer, image, BarcodeSymbology.AustralianPost4State, "11-12345678", New LeadRect(10, 900, 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 USPS barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.USPS4State) 
 
         ' Read the Royal Mail barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.RoyalMail4State) ' 
 
         ' Read the Australian Post barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.AustralianPost4State) 
      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 FourStateBarcodeWriteOptions() 
   options.TextPosition = BarcodeOutputTextPosition.Default 
   options.XModule = 30 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable 
 
   ' 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 FourStateBarcodeReadOptions() 
   options.SearchDirection = BarcodeSearchDirection.Horizontal 
   options.Granularity = 9 
   options.ReturnCheckDigit = BarcodeReturnCheckDigit.Default 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable 
 
   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 FourStateBarcode_Example(RasterImage image, Stream outStream) 
{ 
   BarcodeEngine engine = new BarcodeEngine(); 
 
   // Create the image to write the barcodes to 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Write a few Four-State barcodes, a USPS, Royal Mail and Australian Post 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.USPS4State, "0123456709498765432101234567891", new LogicalRectangle(10, 100, 400, 200, LogicalUnit.Pixel)); 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.RoyalMail4State, "123456789", new LogicalRectangle(10, 500, 400, 200, LogicalUnit.Pixel)); 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.AustralianPost4State, "11-12345678", new LogicalRectangle(10, 900, 400, 200, LogicalUnit.Pixel)); 
 
   // Save the image 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1); 
 
   // Now read the barcodes again 
   // Read the USPS barcode 
   ReadBarcodes(engine.Reader, image, BarcodeSymbology.USPS4State); 
 
   // Read the Royal Mail barcode 
   ReadBarcodes(engine.Reader, image, BarcodeSymbology.RoyalMail4State); 
 
   // Read the Australian Post barcode 
   ReadBarcodes(engine.Reader, image, BarcodeSymbology.AustralianPost4State); 
} 
 
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 
   FourStateBarcodeWriteOptions options = new FourStateBarcodeWriteOptions(); 
   options.TextPosition = BarcodeOutputTextPosition.Default; 
   options.XModule = 30; 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable; 
 
   // 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 
   FourStateBarcodeReadOptions options = new FourStateBarcodeReadOptions(); 
   options.SearchDirection = BarcodeSearchDirection.Horizontal; 
   options.Granularity = 9; 
   options.ReturnCheckDigit = BarcodeReturnCheckDigit.Default; 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable; 
 
   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 FourStateBarcode_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 few Four-State barcodes, a USPS, Royal Mail and Australian Post 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.USPS4State, "0123456709498765432101234567891", New LogicalRectangle(10, 100, 400, 200, LogicalUnit.Pixel)) 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.RoyalMail4State, "123456789", New LogicalRectangle(10, 500, 400, 200, LogicalUnit.Pixel)) 
   WriteBarcode(engine.Writer, image, BarcodeSymbology.AustralianPost4State, "11-12345678", New LogicalRectangle(10, 900, 400, 200, LogicalUnit.Pixel)) 
 
   ' Save the image 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1) 
 
   ' Now read the barcodes again 
   ' Read the USPS barcode 
   ReadBarcodes(engine.Reader, image, BarcodeSymbology.USPS4State) 
 
   ' Read the Royal Mail barcode 
   ReadBarcodes(engine.Reader, image, BarcodeSymbology.RoyalMail4State) 
 
   ' Read the Australian Post barcode 
   ReadBarcodes(engine.Reader, image, BarcodeSymbology.AustralianPost4State) 
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 FourStateBarcodeWriteOptions = New FourStateBarcodeWriteOptions() 
   options.TextPosition = BarcodeOutputTextPosition.Default 
   options.XModule = 30 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable 
 
   ' 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 FourStateBarcodeReadOptions = New FourStateBarcodeReadOptions() 
   options.SearchDirection = BarcodeSearchDirection.Horizontal 
   options.Granularity = 9 
   options.ReturnCheckDigit = BarcodeReturnCheckDigit.Default 
   options.AustralianPostCIFEncoding = AustralianPost4StateBarcodeCIFEncoding.CTable 
 
   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