PatchCodeBarcodeWriteOptions Class

Summary

Contains extra options to use when writing Patch Code barcodes.

Syntax

Objective-C

C++/CLI

Java

Python

[SerializableAttribute()] 
public class PatchCodeBarcodeWriteOptions : BarcodeWriteOptions

@interface LTPatchCodeBarcodeWriteOptions : LTBarcodeWriteOptions

public class PatchCodeBarcodeWriteOptions extends BarcodeWriteOptions

[TypeConverterAttribute()] 
[SerializableAttribute()] 
public ref class PatchCodeBarcodeWriteOptions : public BarcodeWriteOptions, System.ICloneable

class PatchCodeBarcodeWriteOptions(BarcodeWriteOptions):

Remarks

The PatchCodeBarcodeWriteOptions class is used to control the options when writing Patch Code 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, passing one of the following:

BarcodeSymbology.PatchCode

. Then change the members of the returned PatchCodeBarcodeWriteOptions, by casting it from BarcodeWriteOptions to PatchCodeBarcodeWriteOptions.

You can also create an instance of the PatchCodeBarcodeWriteOptions 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.PatchCode

In addition to these features and members, PatchCodeBarcodeWriteOptions contains these Patch Code barcodes specific features:

Member	Description
UseXModule	Use the XModule when writing barcodes of this type
XModule	The size of the smallest module when writing a Patch Code barcode

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
 
 
public void PatchCodeBarcode_Example() 
{ 
   string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyPatchCodeBarcode.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 two PatchCode barcodes 
      WriteBarcode(engine.Writer, image, "1100"); 
 
      // 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 PatchCode barcode 
         ReadBarcode(engine.Reader, image); 
      } 
   } 
} 
 
private void WriteBarcode(BarcodeWriter writer, RasterImage image, string value) 
{ 
   // Create the barcode data 
   BarcodeData barcode = new BarcodeData(BarcodeSymbology.PatchCode, value); 
 
   // Set the write options 
   PatchCodeBarcodeWriteOptions options = new PatchCodeBarcodeWriteOptions(); 
   // Use X Module when writing the barcode 
   options.UseXModule = true; 
   options.XModule = 30; 
 
   // Usually PatchCodes are centered in the middle of the page and take the whole height 
 
   // Calculate its size 
   writer.CalculateBarcodeDataBounds(new LeadRect(0, 0, image.ImageWidth, image.ImageHeight), image.XResolution, image.YResolution, barcode, options); 
 
   // Position it 
   LeadRect pixels = barcode.Bounds; 
   pixels.X = (image.ImageWidth - pixels.Width) / 2; 
   pixels.Y = 0; 
   pixels.Height = image.ImageHeight; 
   barcode.Bounds = new LeadRect(); 
 
   // Write it 
   Console.WriteLine("Writing barcode with Data: {0}", value); 
   writer.WriteBarcode(image, barcode, options); 
} 
 
private void ReadBarcode(BarcodeReader reader, RasterImage image) 
{ 
   // Setup read options 
   PatchCodeBarcodeReadOptions options = new PatchCodeBarcodeReadOptions(); 
   options.SearchDirection = BarcodeSearchDirection.Horizontal; 
   options.Granularity = 9; 
 
   Console.WriteLine("Reading PatchCode barcode"); 
   BarcodeData barcode = reader.ReadBarcode(image, LeadRect.Empty, BarcodeSymbology.PatchCode, 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"; 
}

 
import static org.junit.Assert.assertTrue; 
 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.Test; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
 
import leadtools.*; 
import leadtools.barcode.*; 
import leadtools.codecs.*; 
 
 
public void patchCodeBarcodeExample() { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String imageFileName = combine(LEAD_VARS_IMAGES_DIR, "PatchCodeBarcode.tif"); 
   RasterCodecs codecs = new RasterCodecs(); 
   BarcodeEngine engine = new BarcodeEngine(); 
 
   // Create the image to write the barcodes to 
   int resolution = 300; 
   RasterImage image = RasterImage.create((int) (8.5 * resolution), (int) (11.0 * resolution), 1, resolution, 
         RasterColor.fromKnownColor(RasterKnownColor.WHITE)); 
 
   // Write two PatchCode barcodes 
   writeBarcode(engine.getWriter(), image, "1100"); 
 
   // Save the image 
   codecs.save(image, imageFileName, RasterImageFormat.CCITT_GROUP4, 1); 
 
   // Now read the barcodes again 
   image = codecs.load(imageFileName); 
 
   // Read the PatchCode barcode 
   readBarcode(engine.getReader(), image); 
 
   // Clean up 
   codecs.dispose(); 
   image.dispose(); 
 
   assertTrue("File unsuccessfully saved to " + imageFileName, new File(imageFileName).exists()); 
   System.out.printf("File successfully saved to %s%n", imageFileName); 
} 
 
// Create the barcode data 
private void writeBarcode(BarcodeWriter writer, RasterImage image, String value) { 
   BarcodeData barcode = new BarcodeData(BarcodeSymbology.PATCH_CODE, value); 
 
   // Set the write options 
   PatchCodeBarcodeWriteOptions options = new PatchCodeBarcodeWriteOptions(); 
   // Use X Module when writing the barcode 
   options.setUseXModule(true); 
   options.setXModule(30); 
 
   // Usually PatchCodes are centered in the middle of the page and take the whole 
   // height 
 
   // Calculate its size 
   writer.calculateBarcodeDataBounds(new LeadRect(0, 0, image.getImageWidth(), image.getImageHeight()), 
         image.getXResolution(), image.getYResolution(), barcode, options); 
 
   // Position it 
   LeadRect pixels = barcode.getBounds(); 
   pixels.setX(image.getImageWidth() - pixels.getWidth() / 2); 
   pixels.setY(0); 
   pixels.setHeight(image.getImageHeight()); 
   barcode.setBounds(new LeadRect()); 
 
   // Write it 
   System.out.printf("Writing barcode with Data: %s%n", value); 
   writer.writeBarcode(image, barcode, options); 
} 
 
// Setup read options 
private void readBarcode(BarcodeReader reader, RasterImage image) { 
   PatchCodeBarcodeReadOptions options = new PatchCodeBarcodeReadOptions(); 
   options.setSearchDirection(BarcodeSearchDirection.HORIZONTAL); 
   options.setGranularity(9); 
 
   System.out.println("Reading PatchCode barcode"); 
   BarcodeData barcode = reader.readBarcode(image, LeadRect.getEmpty(), BarcodeSymbology.PATCH_CODE, options); 
   if (barcode != null) { 
      System.out.printf(" At %1s, data: %2s%n", barcode.getBounds(), barcode.getValue()); 
   } else { 
      System.out.println(" Not found"); 
   } 
} 
 
public static String combine(String path1, String path2) { 
   File file = new File(path1, path2); 
   return file.getPath(); 
}