PostNetPlanetBarcodeReadOptions Class

Summary

Contains the extra options to use when reading POSTNET and PLANET barcodes.

Syntax

Objective-C

C++

Java

[SerializableAttribute()] 
public class PostNetPlanetBarcodeReadOptions : BarcodeReadOptions

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

@interface LTPostNetPlanetBarcodeReadOptions : LTBarcodeReadOptions

public class PostNetPlanetBarcodeReadOptions extends BarcodeReadOptions

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

Remarks

The PostNetPlanetBarcodeReadOptions class is used to control the options when reading POSTNET and PLANET 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 PostNetPlanetBarcodeReadOptions by casting it from BarcodeReadOptions to PostNetPlanetBarcodeReadOptions.

You can also create an instance of the PostNetPlanetBarcodeReadOptions 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.PostNet and BarcodeSymbology.Planet

In addition to the features and members, the PostNetPlanetBarcodeReadOptions contains these POSTNET/PLANET 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
WhiteLinesNumber	The minimum number of lines of white space above and below the barcode symbol
ReturnCheckDigit	The error check digit is returned as part of the barcode data

Example

This example writes a POSTNET and a PLANET barcodes to an image and then reads them back.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
 
 
public void PostNetPlanetBarcode_Example() 
{ 
	string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyPostNetPlanetBarcodes.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.PostNet, "123456789", new LeadRect(10, 100, 400, 200)); 
		WriteBarcode(engine.Writer, image, BarcodeSymbology.Planet, "12345678901", new LeadRect(10, 500, 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 POSTNET barcode 
			ReadBarcodes(engine.Reader, image, BarcodeSymbology.PostNet); 
 
			// Read the PLANET barcode 
			ReadBarcodes(engine.Reader, image, BarcodeSymbology.Planet); 
		} 
	} 
} 
 
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 
	PostNetPlanetBarcodeWriteOptions options = new PostNetPlanetBarcodeWriteOptions(); 
	options.UseXModule = false; 
	options.XModule = 30; 
 
	// 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 
	PostNetPlanetBarcodeReadOptions options = new PostNetPlanetBarcodeReadOptions(); 
	options.SearchDirection = BarcodeSearchDirection.Horizontal; 
	options.Granularity = 9; 
	options.WhiteLinesNumber = 3; 
	options.ReturnCheckDigit = BarcodeReturnCheckDigit.Default; 
 
	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:\LEADTOOLS21\Resources\Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Barcode 
Imports Leadtools.ImageProcessing 
 
Public Sub PostNetPlanetBarcode_Example() 
   Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "MyPostNetPlanetBarcodes.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.PostNet, "123456789", New LeadRect(10, 100, 400, 200)) 
      WriteBarcode(engine.Writer, image, BarcodeSymbology.Planet, "12345678901", New LeadRect(10, 500, 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 POSTNET barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.PostNet) 
 
         ' Read the PLANET barcode 
         ReadBarcodes(engine.Reader, image, BarcodeSymbology.Planet) 
      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 PostNetPlanetBarcodeWriteOptions() 
   options.UseXModule = False 
   options.XModule = 30 
 
   ' 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 PostNetPlanetBarcodeReadOptions() 
   options.SearchDirection = BarcodeSearchDirection.Horizontal 
   options.Granularity = 9 
   options.WhiteLinesNumber = 3 
   options.ReturnCheckDigit = BarcodeReturnCheckDigit.Default 
 
   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:\LEADTOOLS21\Resources\Images" 
End Class