PDF417BarcodeData Class

Summary

Contains the data for a single MicroPDF417 barcode.

Syntax

Objective-C

C++

Java

[SerializableAttribute()] 
public class PDF417BarcodeData : BarcodeData

<TypeConverterAttribute()> 
<SerializableAttribute()> 
Public Class PDF417BarcodeData  
   Inherits BarcodeData 
   Implements System.ICloneable

@interface LTPDF417BarcodeData : LTBarcodeData <NSCopying>

public class PDF417BarcodeData extends BarcodeData

[TypeConverterAttribute()] 
[SerializableAttribute()] 
public ref class PDF417BarcodeData : public BarcodeData, System.ICloneable

Remarks

The MicroPDF417BarcodeData class derives from the base BarcodeData to add specific data that can be read or written when using MicroPDF417 barcodes.

Reading Barcodes

When the BarcodeReader object detects and reads a MicroPDF417 ( BarcodeSymbology.MicroPDF417), the BarcodeReader.ReadBarcode and BarcodeReader.ReadBarcodes methods will return the MicroPDF417BarcodeData object for each barcode cast down to the base BarcodeData class.

Perform standard .NET casting to get the object as MicroPDF417BarcodeData and then examine the extra data properties associated with it.

In addition to all the data members returned as usual in the base BarcodeData object, this class adds the following members:

DataCode - The MicroPDF417 barcode function code word for Code 128 emulation.
IsLinked - Indicates that the MicroPDF417 barcode is linked to a linear symbol printed below it.

In addition to the members above, other MicroPDF417 read options not related to the barcode data can be set using the MicroPDF417BarcodeReadOptions class.

Writing Barcodes

The BarcodeWriter class contains the WriteBarcode method that is used to write a barcode to an image. This method accept the data parameter as the base BarcodeData object. To write a MicroPDF417 barcode, create an instance of MicroPDF417BarcodeData and fill the required parameters then pass this object as the data parameter to WriteBarcode.

In addition to all the data members that must be set as usual in the base BarcodeData object, you must also specify the following members:

Group - The group number if this PDF417 barcode symbol is a member of a group of symbols

In addition to the members above, other MicroPDF417 write options not related to the barcode data can be set using the MicroPDF417BarcodeWriteOptions class.

Use the static (or Shared in VB) BarcodeData.CreateDefaultBarcodeData method to create a new instance of MicroPDF417BarcodeData that contains default parameters ready for writing to an image:

VB Snippet

Dim microPDF417Data As MicroPDF417BarcodeData = DirectCast(BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.MicroPDF417), MicroPDF417BarcodeData)

C# Snippet

MicroPDF417BarcodeData microPDF417Data = BarcodeData.CreateDefaultBarcodeData(BarcodeSymbology.MicroPDF417) as MicroPDF417BarcodeData;

Example

This example writes a couple of PDF417 barcode with different options to an image and then reads them back.

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; 
 
   // 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; 
 
   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} and data: {1}", barcode.Bounds, barcode.Value); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Barcode 
Imports Leadtools.ImageProcessing 
 
Public Sub PDF417Barcode_Example() 
   Dim imageFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "MyPDF417Barcodes.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 PDF417 barcodes 
      WriteBarcode(engine.Writer, image, "DATA1", 10, 10, True) 
      WriteBarcode(engine.Writer, image, "DATA2", 20, 20, False) 
 
      ' 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) 
         ReadBarcodes(engine.Reader, image) 
      End Using 
   End Using 
End Sub 
 
Private Sub WriteBarcode(ByVal writer As BarcodeWriter, ByVal image As RasterImage, ByVal value As String, ByVal rows As Integer, ByVal columns As Integer, ByVal topLeft As Boolean) 
   ' Create the barcode data 
   Dim barcode As New PDF417BarcodeData() 
   barcode.Value = value 
   barcode.Group = 0 
 
   ' 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 
   Dim options As New PDF417BarcodeWriteOptions() 
 
   If topLeft Then 
      options.HorizontalAlignment = BarcodeAlignment.Near 
      options.VerticalAlignment = BarcodeAlignment.Near 
   Else 
      options.HorizontalAlignment = BarcodeAlignment.Far 
      options.VerticalAlignment = BarcodeAlignment.Far 
   End If 
 
   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) 
End Sub 
 
Private Sub ReadBarcodes(ByVal reader As BarcodeReader, ByVal image As RasterImage) 
   ' Setup read options 
   Dim options As 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 
 
   Console.WriteLine("Reading Barcodes") 
   Dim barcodes() As BarcodeData = reader.ReadBarcodes(image, LeadRect.Empty, 0, New BarcodeSymbology() {BarcodeSymbology.PDF417}, New BarcodeReadOptions() {options}) 
   Console.WriteLine("{0} barcodes found:", barcodes.Length) 
   For Each barcode As PDF417BarcodeData In barcodes 
      Console.WriteLine(" At {0} and data: {1}", barcode.Bounds, barcode.Value) 
   Next 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

c#[Silverlight C# Example] 
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms; 
using Leadtools.Barcode; 
using Leadtools.ImageProcessing; 
using Leadtools.Examples; 
 
public void PDF417Barcode_Example(RasterImage image, Stream outStream) 
{ 
   BarcodeEngine engine = new BarcodeEngine(); 
 
   // Create the image to write the barcodes to 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Write two PDF417 barcodes 
   WriteBarcode(engine.Writer, image, "DATA1", 10, 10, true); 
   WriteBarcode(engine.Writer, image, "DATA2", 20, 20, false); 
 
   // Save the image 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1); 
 
   // Now read the barcodes again 
   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; 
 
   // We will use the alignment to position the barcodes, so use all of the image 
   barcode.Bounds = new LogicalRectangle(0, 0, image.ImageWidth, image.ImageHeight, LogicalUnit.Pixel); 
 
   // 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; 
 
   Console.WriteLine("Reading Barcodes"); 
   BarcodeData[] barcodes = reader.ReadBarcodes(image, LogicalRectangle.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} and data: {1}", barcode.Bounds, barcode.Value); 
   } 
} 
vb[Silverlight VB Example] 
Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms 
Imports Leadtools.Barcode 
Imports Leadtools.ImageProcessing 
 
Public Sub PDF417Barcode_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 PDF417 barcodes 
   WriteBarcode(engine.Writer, image, "DATA1", 10, 10, True) 
   WriteBarcode(engine.Writer, image, "DATA2", 20, 20, False) 
 
   ' Save the image 
   codecs.Save(image, outStream, RasterImageFormat.CcittGroup4, 1) 
 
   ' Now read the barcodes again 
   ReadBarcodes(engine.Reader, image) 
End Sub 
 
Private Sub WriteBarcode(ByVal writer As BarcodeWriter, ByVal image As RasterImage, ByVal value As String, ByVal rows As Integer, ByVal columns As Integer, ByVal topLeft As Boolean) 
   ' Create the barcode data 
   Dim barcode As PDF417BarcodeData = New PDF417BarcodeData() 
   barcode.Value = value 
   barcode.Group = 0 
 
   ' We will use the alignment to position the barcodes, so use all of the image 
   barcode.Bounds = New LogicalRectangle(0, 0, image.ImageWidth, image.ImageHeight, LogicalUnit.Pixel) 
 
   ' Set the write options 
   Dim options As PDF417BarcodeWriteOptions = New PDF417BarcodeWriteOptions() 
 
   If topLeft Then 
      options.HorizontalAlignment = BarcodeAlignment.Near 
      options.VerticalAlignment = BarcodeAlignment.Near 
   Else 
      options.HorizontalAlignment = BarcodeAlignment.Far 
      options.VerticalAlignment = BarcodeAlignment.Far 
   End If 
 
   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) 
End Sub 
 
Private Sub ReadBarcodes(ByVal reader As BarcodeReader, ByVal image As RasterImage) 
   ' Setup read options 
   Dim options As PDF417BarcodeReadOptions = 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 
 
   Console.WriteLine("Reading Barcodes") 
   Dim barcodes As BarcodeData() = reader.ReadBarcodes(image, LogicalRectangle.Empty, 0, New BarcodeSymbology() {BarcodeSymbology.PDF417}, New BarcodeReadOptions() {options}) 
   Console.WriteLine("{0} barcodes found:", barcodes.Length) 
   For Each barcode As PDF417BarcodeData In barcodes 
      Console.WriteLine(" At {0} and data: {1}", barcode.Bounds, barcode.Value) 
   Next barcode 
End Sub

Requirements

Target Platforms

Download our FREE evaluation

Help Version 20.0.2020.4.2

Leadtools.Barcode Assembly

Introduction

Getting Started

Namespaces

Leadtools.Barcode Namespace

Assemblies

PDF417BarcodeData Class

Reading Barcodes

Writing Barcodes

Reference