Leadtools.Barcode Namespace : PatchCodeBarcodeReadOptions Class |
[TypeConverterAttribute()] [SerializableAttribute()] public class PatchCodeBarcodeReadOptions : BarcodeReadOptions, System.ICloneable
'Declaration <TypeConverterAttribute()> <SerializableAttribute()> Public Class PatchCodeBarcodeReadOptions Inherits BarcodeReadOptions Implements System.ICloneable
'Usage Dim instance As PatchCodeBarcodeReadOptions
public sealed class PatchCodeBarcodeReadOptions : System.ICloneable
@interface LTPatchCodeBarcodeReadOptions : LTBarcodeReadOptions
public class PatchCodeBarcodeReadOptions extends BarcodeReadOptions
function Leadtools.Barcode.PatchCodeBarcodeReadOptions()
[TypeConverterAttribute()] [SerializableAttribute()] public ref class PatchCodeBarcodeReadOptions : public BarcodeReadOptions, System.ICloneable
The PatchCodeBarcodeReadOptions class is used to control the options when reading Patch Code 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:
Then change the members of the returned PatchCodeBarcodeReadOptions by casting it from BarcodeReadOptions to PatchCodeBarcodeReadOptions.
Also create an instance of the PatchCodeBarcodeReadOptions class and use it directly in the BarcodeReader.ReadBarcode and BarcodeReader.ReadBarcodes methods that accepts 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.PatchCode |
In addition to the features features and members, the PatchCodeBarcodeReadOptions contains these Patch Code 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 |
Imports Leadtools Imports Leadtools.Codecs Imports Leadtools.Forms Imports Leadtools.Barcode Imports Leadtools.ImageProcessing Public Sub PatchCodeBarcode_Example() Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "MyPatchCodeBarcode.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 two PatchCode barcodes WriteBarcode(engine.Writer, image, "1100") ' 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 PatchCode barcode ReadBarcode(engine.Reader, image) End Using End Using End Sub Private Sub WriteBarcode(ByVal writer As BarcodeWriter, ByVal image As RasterImage, ByVal value As String) ' Create the barcode data Dim barcode As New BarcodeData(BarcodeSymbology.PatchCode, value) ' Set the write options Dim options As 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 LogicalRectangle(0, 0, image.ImageWidth, image.ImageHeight, LogicalUnit.Pixel), image.XResolution, image.YResolution, barcode, options) ' Position it Dim pixels As LeadRect = barcode.Bounds.ToRectangle(image.XResolution, image.YResolution) pixels.X = (image.ImageWidth - pixels.Width) \ 2 pixels.Y = 0 pixels.Height = image.ImageHeight barcode.Bounds = New LogicalRectangle(pixels) ' Write it Console.WriteLine("Writing barcode with Data: {0}", value) writer.WriteBarcode(image, barcode, options) End Sub Private Sub ReadBarcode(ByVal reader As BarcodeReader, ByVal image As RasterImage) ' Setup read options Dim options As New PatchCodeBarcodeReadOptions() options.SearchDirection = BarcodeSearchDirection.Horizontal options.Granularity = 9 Console.WriteLine("Reading PatchCode barcode") Dim barcode As BarcodeData = reader.ReadBarcode(image, LogicalRectangle.Empty, BarcodeSymbology.PatchCode, 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
using Leadtools; using Leadtools.Codecs; using Leadtools.Forms; 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 LogicalRectangle(0, 0, image.ImageWidth, image.ImageHeight, LogicalUnit.Pixel), image.XResolution, image.YResolution, barcode, options); // Position it LeadRect pixels = barcode.Bounds.ToRectangle(image.XResolution, image.YResolution); pixels.X = (image.ImageWidth - pixels.Width) / 2; pixels.Y = 0; pixels.Height = image.ImageHeight; barcode.Bounds = new LogicalRectangle(pixels); // 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, LogicalRectangle.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:\Users\Public\Documents\LEADTOOLS Images"; }
using Leadtools; using Leadtools.Codecs; using Leadtools.Barcode; using Leadtools.ImageProcessing; public async Task PatchCodeBarcode_Example() { string imageFileName = @"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, RasterColorHelper.FromKnownColor(RasterKnownColor.White))) { // Write two PatchCode barcodes WriteBarcode(engine.Writer, image, "1100"); // Save the image using(RasterCodecs codecs = new RasterCodecs()) { StorageFile saveFile = await Tools.AppLocalFolder.CreateFileAsync(imageFileName); await codecs.SaveAsync(image, LeadStreamFactory.Create(saveFile), RasterImageFormat.CcittGroup4, 1); } } // Now read the barcodes again using(RasterCodecs codecs = new RasterCodecs()) { StorageFile loadFile = await Tools.AppInstallFolder.GetFileAsync(imageFileName); using(RasterImage image = await codecs.LoadAsync(LeadStreamFactory.Create(loadFile))) { // 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(LeadRectHelper.Create(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 = pixels; // Write it Debug.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; Debug.WriteLine("Reading PatchCode barcode"); BarcodeData barcode = reader.ReadBarcode(image, LeadRectHelper.Empty, BarcodeSymbology.PatchCode, options); if(barcode != null) { Debug.WriteLine(" At {0}, data: {1}", barcode.Bounds, barcode.Value); } else { Debug.WriteLine(" Not found"); } }
using Leadtools; using Leadtools.Codecs; using Leadtools.Forms; using Leadtools.Barcode; using Leadtools.ImageProcessing; using Leadtools.Examples; public void PatchCodeBarcode_Example(RasterImage image, Stream outStream) { BarcodeEngine engine = new BarcodeEngine(); // Create the image to write the barcodes to RasterCodecs codecs = new RasterCodecs(); // Write two PatchCode barcodes WriteBarcode(engine.Writer, image, "1100"); // Save the image codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1); // Now read the barcodes again 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 LogicalRectangle(0, 0, image.ImageWidth, image.ImageHeight, LogicalUnit.Pixel), image.XResolution, image.YResolution, barcode, options); // Position it LeadRect pixels = barcode.Bounds.ToRectangle(image.XResolution, image.YResolution); pixels.X = (image.ImageWidth - pixels.Width) / 2; pixels.Y = 0; pixels.Height = image.ImageHeight; barcode.Bounds = new LogicalRectangle(pixels); // 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, LogicalRectangle.Empty, BarcodeSymbology.PatchCode, options); if(barcode != null) { Console.WriteLine(" At {0}, data: {1}", barcode.Bounds, barcode.Value); } else { Console.WriteLine(" Not found"); } }
Imports Leadtools Imports Leadtools.Codecs Imports Leadtools.Forms Imports Leadtools.Barcode Imports Leadtools.ImageProcessing Public Sub PatchCodeBarcode_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 two PatchCode barcodes WriteBarcode(engine.Writer, image, "1100") ' Save the image codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1) ' Now read the barcodes again ReadBarcode(engine.Reader, image) End Sub Private Sub WriteBarcode(ByVal writer As BarcodeWriter, ByVal image As RasterImage, ByVal value As String) ' Create the barcode data Dim barcode As BarcodeData = New BarcodeData(BarcodeSymbology.PatchCode, value) ' Set the write options Dim options As PatchCodeBarcodeWriteOptions = 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 LogicalRectangle(0, 0, image.ImageWidth, image.ImageHeight, LogicalUnit.Pixel), image.XResolution, image.YResolution, barcode, options) ' Position it Dim pixels As LeadRect = barcode.Bounds.ToRectangle(image.XResolution, image.YResolution) pixels.X = (image.ImageWidth - pixels.Width) / 2 pixels.Y = 0 pixels.Height = image.ImageHeight barcode.Bounds = New LogicalRectangle(pixels) ' Write it Console.WriteLine("Writing barcode with Data: {0}", value) writer.WriteBarcode(image, barcode, options) End Sub Private Sub ReadBarcode(ByVal reader As BarcodeReader, ByVal image As RasterImage) ' Setup read options Dim options As PatchCodeBarcodeReadOptions = New PatchCodeBarcodeReadOptions() options.SearchDirection = BarcodeSearchDirection.Horizontal options.Granularity = 9 Console.WriteLine("Reading PatchCode barcode") Dim barcode As BarcodeData = reader.ReadBarcode(image, LogicalRectangle.Empty, BarcodeSymbology.PatchCode, 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
PatchCodeBarcodeReadOptions Members
Leadtools.Barcode Namespace
BarcodeData Class
BarcodeReader Class
BarcodeSymbology Enumeration
BarcodeEngine Class
BarcodeReader.ReadBarcode
BarcodeReader.ReadBarcodes
Programming with LEADTOOLS Barcode
Supported Barcode Symbologies
Unlocking Barcode Support
Reading Barcodes Tutorial
USPS and 4-State Barcodes in LEADTOOLS