Class Pdf417Parameters
Namespace: Aspose.BarCode.Generation
Assembly: Aspose.BarCode.dll (25.2.0)
PDF417 parameters. Contains PDF417, MacroPDF417, MicroPDF417 and GS1MicroPdf417 parameters. MacroPDF417 requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional. MicroPDF417 in Structured Append mode (same as MacroPDF417 mode) requires two fields: Pdf417MacroFileID and Pdf417MacroSegmentID. All other fields are optional.
[XmlSerialization(Name = "Aspose.BarCode.Reader.Properties.BarcodeParameters.Pdf417Parameters")]
public class Pdf417ParametersInheritance
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Examples
These samples show how to encode UCC/EAN-128 non Linked modes in GS1MicroPdf417
//Encodes GS1 UCC/EAN-128 non Linked mode 905 with AI 01 (GTIN)
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(01)12345678901231");
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText);
//Encodes GS1 UCC/EAN-128 non Linked modes 903, 904 with any AI
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(241)123456789012345(241)ABCD123456789012345");
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText);Properties
AspectRatio
Height/Width ratio of 2D BarCode module.
[XmlSerialization(Type = XmlSerializationType.Element)]
public float AspectRatio { get; set; }Property Value
Columns
Columns count.
[XmlSerialization(Type = XmlSerializationType.Element)]
public int Columns { get; set; }Property Value
IsCode128Emulation
Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and 909, also can encode 910 and 911 which just indicate that recognized MicroPdf417 can be interpret as Code 128
[XmlSerialization(Type = XmlSerializationType.Element)]
public bool IsCode128Emulation { get; set; }Property Value
Examples
These samples show how to encode Code 128 emulation modes with FNC1 in second position and without. In this way MicroPdf417 can be decoded as Code 128 barcode
//Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "a", mode 908.
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.MicroPdf417, "a\u001d1222322323");
generator.Parameters.Barcode.Pdf417.IsCode128Emulation = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsCode128Emulation:" + result.Extended.Pdf417.IsCode128Emulation.ToString());
//Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "99", mode 909.
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.MicroPdf417, "99\u001d1222322323");
generator.Parameters.Barcode.Pdf417.IsCode128Emulation = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsCode128Emulation:" + result.Extended.Pdf417.IsCode128Emulation.ToString());
//Encodes MicroPdf417 in Code 128 emulation mode, modes 910, 911
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.MicroPdf417, "123456789012345678");
generator.Parameters.Barcode.Pdf417.IsCode128Emulation = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsCode128Emulation:" + result.Extended.Pdf417.IsCode128Emulation.ToString());IsLinked
Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907, 912, 913, 914, 915 “Linked” UCC/EAN-128 modes With MicroPdf417 and Pdf417 symbologies encodes 918 linkage flag to associated linear component other than an EAN.UCC
[XmlSerialization(Type = XmlSerializationType.Element)]
public bool IsLinked { get; set; }Property Value
Examples
These samples show how to encode “Linked” UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes
//Encodes GS1 Linked mode 912 with date field AI 11 (Production date) and AI 10 (Lot number)
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(11)991231(10)ABCD");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes GS1 Linked mode 912 with date field AI 13 (Packaging date) and AI 21 (Serial number)
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(13)991231(21)ABCD");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes GS1 Linked mode 912 with date field AI 15 (Sell-by date) and AI 10 (Lot number)
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(15)991231(10)ABCD");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes GS1 Linked mode 912 with date field AI 17 (Expiration date) and AI 21 (Serial number)
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(17)991231(21)ABCD");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes GS1 Linked mode 914 with AI 10 (Lot number)
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(10)ABCD12345");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes GS1 Linked mode 915 with AI 21 (Serial number)
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(21)ABCD12345");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes GS1 Linked modes 906, 907 with any AI
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.GS1MicroPdf417, "(240)123456789012345");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes MicroPdf417 NON EAN.UCC Linked mode 918
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.MicroPdf417, "ABCDE123456789012345678");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());
//Encodes Pdf417 NON EAN.UCC Linked mode 918
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.Pdf417, "ABCDE123456789012345678");
generator.Parameters.Barcode.Pdf417.IsLinked = true;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.Pdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText + " IsLinked:" + result.Extended.Pdf417.IsLinked.ToString());IsReaderInitialization
Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.
[XmlSerialization(Type = XmlSerializationType.Element)]
public bool IsReaderInitialization { get; set; }Property Value
MacroCharacters
Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with MicroPdf417 and encodes 916 and 917 MicroPdf417 modes Default value: MacroCharacters.None.
[XmlSerialization(Type = XmlSerializationType.Element)]
public MacroCharacter MacroCharacters { get; set; }Property Value
Examples
These samples show how to encode Macro Characters in MicroPdf417
//Encodes MicroPdf417 with 05 Macro the string: "[)>\u001E05\u001Dabcde1234\u001E\u0004"
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.MicroPdf417, "abcde1234");
generator.Parameters.Barcode.Pdf417.MacroCharacters = MacroCharacter.Macro05;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText);
//Encodes MicroPdf417 with 06 Macro the string: "[)>\u001E06\u001Dabcde1234\u001E\u0004"
BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.MicroPdf417, "abcde1234");
generator.Parameters.Barcode.Pdf417.MacroCharacters = MacroCharacter.Macro06;
using (BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.MicroPdf417))
foreach (BarCodeResult result in reader.ReadBarCodes())
Console.WriteLine(result.CodeText);Pdf417CompactionMode
Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.Auto.
[Obsolete("This property is obsolete and will be removed in future releases. Instead, use the Pdf417EncodeMode property.", false)]
[XmlSerialization(Type = XmlSerializationType.Element)]
public Pdf417CompactionMode Pdf417CompactionMode { get; set; }Property Value
Pdf417ECIEncoding
Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Not applied for Macro PDF417 text fields. Current implementation consists all well known charset encodings.
[XmlSerialization(Type = XmlSerializationType.Element)]
public ECIEncodings Pdf417ECIEncoding { get; set; }Property Value
Pdf417EncodeMode
Identifies Pdf417 encode mode. Default value: Auto.
[XmlSerialization(Type = XmlSerializationType.Element)]
public Pdf417EncodeMode Pdf417EncodeMode { get; set; }Property Value
Pdf417ErrorLevel
Gets or sets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error correction info, level8 means best error correction which means a larger picture.
[XmlSerialization(Type = XmlSerializationType.Element)]
public Pdf417ErrorLevel Pdf417ErrorLevel { get; set; }Property Value
Pdf417MacroAddressee
MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)
[XmlSerialization(Type = XmlSerializationType.Element)]
public string Pdf417MacroAddressee { get; set; }Property Value
Pdf417MacroChecksum
MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode) The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial. x^16 + x^12 + x^5 + 1
[XmlSerialization(Type = XmlSerializationType.Element)]
public int Pdf417MacroChecksum { get; set; }Property Value
Pdf417MacroECIEncoding
Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
[XmlSerialization(Type = XmlSerializationType.Element)]
public ECIEncodings Pdf417MacroECIEncoding { get; set; }Property Value
Pdf417MacroFileID
MacroPdf417 barcode’s file ID (Required field). MicroPDF417 barcode’s file ID (Required field for Structured Append mode)
[XmlSerialization(Type = XmlSerializationType.Element)]
public int Pdf417MacroFileID { get; set; }Property Value
Pdf417MacroFileName
MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)
[XmlSerialization(Type = XmlSerializationType.Element)]
public string Pdf417MacroFileName { get; set; }Property Value
Pdf417MacroFileSize
MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size field contains the size in bytes of the entire source file.
[XmlSerialization(Type = XmlSerializationType.Element)]
public int Pdf417MacroFileSize { get; set; }Property Value
Pdf417MacroSegmentID
MacroPdf417 barcode’s segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode’s segment ID (Required field for Structured Append mode)
[XmlSerialization(Type = XmlSerializationType.Element)]
public int Pdf417MacroSegmentID { get; set; }Property Value
Pdf417MacroSegmentsCount
MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)
[XmlSerialization(Type = XmlSerializationType.Element)]
public int Pdf417MacroSegmentsCount { get; set; }Property Value
Pdf417MacroSender
MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)
[XmlSerialization(Type = XmlSerializationType.Element)]
public string Pdf417MacroSender { get; set; }Property Value
Pdf417MacroTerminator
Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
[XmlSerialization(Type = XmlSerializationType.Element)]
public Pdf417MacroTerminator Pdf417MacroTerminator { get; set; }Property Value
Pdf417MacroTimeStamp
MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)
[XmlSerialization(Type = XmlSerializationType.Element)]
public DateTime Pdf417MacroTimeStamp { get; set; }Property Value
Pdf417Truncate
Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicator and right stop pattern are removed in this mode.
[XmlSerialization(Type = XmlSerializationType.Element)]
public bool Pdf417Truncate { get; set; }Property Value
Rows
Rows count.
[XmlSerialization(Type = XmlSerializationType.Element)]
public int Rows { get; set; }Property Value
Methods
ToString()
Returns a human-readable string representation of this Aspose.BarCode.Generation.Pdf417Parameters.
public override string ToString()Returns
A string that represents this Aspose.BarCode.Generation.Pdf417Parameters.
