PDF417BarcodeReadOptions Class

Summary

Contains extra options to use when reading PDF417 barcodes.

Syntax

Objective-C

C++/CLI

Java

Python

[SerializableAttribute()] 
public class PDF417BarcodeReadOptions : BarcodeReadOptions

@interface LTPDF417BarcodeReadOptions : LTBarcodeReadOptions

public class PDF417BarcodeReadOptions extends BarcodeReadOptions

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

class PDF417BarcodeReadOptions(BarcodeReadOptions):

Remarks

The PDF417BarcodeReadOptions class is used to control the options when reading PDF417 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 BarcodeSymbology.PDF417. Then change the members of the returned PDF417BarcodeReadOptions by casting it from BarcodeReadOptions to PDF417BarcodeReadOptions.

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

In addition to these features and members, the PDF417BarcodeReadOptions contains these PDF417 barcodes specific features:

Member	Description
SearchDirection	The direction to use when searching for barcodes (horizontal, vertical or both).
EnableDoublePass	Enable internal auto preprocessing of the image data if no PDF417 barcode was found.
EnableDoublePassIfSuccess	Enable internal auto preprocessing of the image data even if some PDF417 barcodes were found.
EnablePreprocessing	Enable applying auto segmentation and deep auto pre-processing to the image then re-scanning if no barcodes of this symbology are found.
EnableFastMode	Enable or disable fast PDF417 reading mode.
ReadMode	The channel mode to use when reading PDF417 barcodes.
ReturnCorruptedSymbolArea	Instruct the engine to return the area where an un-readable PDF417 symbol is located (with no data).
ReadOptionalMacroFileNameField, ReadOptionalMacroSegmentCountField, ReadOptionalMacroTimestampField, ReadOptionalMacroSenderField, ReadOptionalMacroAddresseeField, ReadOptionalMacroFileSizeField, ReadOptionalMacroChecksumField and ReadOptionalMacro79AndAZField	Retrieve an optional macro field when reading PDF417 barcodes.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
 
 
public void PDF417Barcode_Example() 
{ 
   string imageFileName = Path.Combine(LEAD_VARS.ImagesDir, "MyPDF417Barcodes.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 PDF417 barcodes 
      WriteBarcode(engine.Writer, image, "DATA1", 10, 10, true); 
      WriteBarcode(engine.Writer, image, "DATA2", 20, 20, false); 
 
      // 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)) 
      { 
         ReadBarcodes(engine.Reader, image); 
      } 
   } 
} 
 
private void WriteBarcode(BarcodeWriter writer, RasterImage image, string value, int rows, int columns, bool topLeft) 
{ 
   // Create the barcode data 
   PDF417BarcodeData barcode = new PDF417BarcodeData(); 
   barcode.Value = value; 
   barcode.Group = 0; 
   barcode.Symbology = BarcodeSymbology.PDF417; 
 
   // We will use the alignment to position the barcodes, so use all of the image 
   barcode.Bounds = new LeadRect(0, 0, image.ImageWidth, image.ImageHeight); 
 
   // Set the write options 
   PDF417BarcodeWriteOptions options = new PDF417BarcodeWriteOptions(); 
 
   if (topLeft) 
   { 
      options.HorizontalAlignment = BarcodeAlignment.Near; 
      options.VerticalAlignment = BarcodeAlignment.Near; 
   } 
   else 
   { 
      options.HorizontalAlignment = BarcodeAlignment.Far; 
      options.VerticalAlignment = BarcodeAlignment.Far; 
   } 
 
   options.Truncated = false; 
   options.EnableGroupMode = false; 
   options.SymbolWidthAspectRatio = 2; 
   options.SymbolHeightAspectRatio = 1; 
   options.LimitByRowsAndColumns = true; 
   options.Rows = rows; 
   options.Columns = columns; 
   options.XModule = 30; 
   options.XModuleAspectRatio = 3; 
   options.ECCLevel = PDF417BarcodeECCLevel.Level0; 
   options.ECCPercentage = 0; 
 
   // Write it 
   Console.WriteLine("Writing barcode with symbol rows/columns: {0}/{1} and Data: {2}", rows, columns, value); 
   writer.WriteBarcode(image, barcode, options); 
} 
 
private void ReadBarcodes(BarcodeReader reader, RasterImage image) 
{ 
   // Setup read options 
   PDF417BarcodeReadOptions options = new PDF417BarcodeReadOptions(); 
   options.SearchDirection = BarcodeSearchDirection.Horizontal; 
   options.EnableDoublePass = false; 
   options.EnableFastMode = false; 
   options.ReadMode = PDF417BarcodeReadMode.Mode0; 
   options.ReturnCorruptedSymbolArea = false; 
   options.ReadOptionalMacroFileNameField = false; 
   options.ReadOptionalMacroSegmentCountField = false; 
   options.ReadOptionalMacroTimestampField = false; 
   options.ReadOptionalMacroSenderField = false; 
   options.ReadOptionalMacroAddresseeField = false; 
   options.ReadOptionalMacroFileSizeField = false; 
   options.ReadOptionalMacroChecksumField = false; 
   options.ReadOptionalMacro79AndAZField = false; 
   options.EnableDoublePassIfSuccess = true; 
   options.EnableNoIndicatorTrail = true; 
   options.EnablePreprocessing = true; 
 
   Console.WriteLine("Reading Barcodes"); 
   BarcodeData[] barcodes = reader.ReadBarcodes(image, LeadRect.Empty, 0, new BarcodeSymbology[] { BarcodeSymbology.PDF417 }, new BarcodeReadOptions[] { options }); 
   Console.WriteLine("{0} barcodes found:", barcodes.Length); 
   foreach (PDF417BarcodeData barcode in barcodes) 
   { 
      Console.WriteLine(" At {0} data: {1} and symbology: {2}", barcode.Bounds, barcode.Value, barcode.Symbology); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
}