←Select platform

FourStateBarcodeWriteOptions Class

Summary
Contains the extra options to use when writing 4-State post barcodes such as USPS, Royal Mail ,and Australian Post.
Syntax
C#
Objective-C
C++/CLI
Java
Python
[SerializableAttribute()] 
public class FourStateBarcodeWriteOptions : BarcodeWriteOptions 
@interface LTFourStateBarcodeWriteOptions : LTBarcodeWriteOptions 
public class FourStateBarcodeWriteOptions extends BarcodeWriteOptions 
[TypeConverterAttribute()] 
[SerializableAttribute()] 
public ref class FourStateBarcodeWriteOptions : public BarcodeWriteOptions, System.ICloneable   
class FourStateBarcodeWriteOptions(BarcodeWriteOptions): 
Remarks

The FourStateBarcodeWriteOptions class is used to control the options when writing 4-State post barcodes using LEADTOOLS. Set the options in two ways:

The BarcodeWriter class contains default options for each barcode symbology (or group of common symbologies). These options can be retrieved using the BarcodeWriter.GetDefaultOptions method by passing one of the following:

. You may then change the members of the returned FourStateBarcodeWriteOptions by casting it from BarcodeWriteOptions to FourStateBarcodeWriteOptions.

You can also create an instance of the FourStateBarcodeWriteOptions class and use it directly in the BarcodeWriter.WriteBarcode method which accepts the options as an input parameter.

The base BarcodeWriteOptions contains the following members and features:

Member Description
BarcodeWriteOptions.ForeColor

Controls the barcode foreground color (color of the bars or symbols) to use when writing a barcode to an image.

BarcodeWriteOptions.BackColor

Controls the barcode background color (color of the spaces) to use when writing a barcode to an image.

BarcodeWriteOptions.Load and BarcodeWriteOptions.Save

Can be used to save or load the options to/from an XML file or stream.

BarcodeWriteOptions.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 the features and members, FourStateBarcodeWriteOptions contains these 4-State post barcodes specific features:

Member Description
TextPosition

The text position to use when the data string is written along with the barcode

XModule

The size of the smallest module when writing a 4-State barcode

AustralianPostCIFEncoding

Australian Post Customer Information Field (CIF) Encoding/Decoding table

Example
C#
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:\LEADTOOLS23\Resources\Images"; 
} 
Requirements

Target Platforms

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Barcode Assembly
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.