Aspose::BarCode::Generation::Pdf417Parameters Class Reference

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. More...

Inherits System::Object.

Public Member Functions

Aspose::BarCode::Generation::Pdf417CompactionMode get_Pdf417CompactionMode () const
 Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.Auto. More...
 
void set_Pdf417CompactionMode (Aspose::BarCode::Generation::Pdf417CompactionMode value)
 Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.Auto. More...
 
Aspose::BarCode::Generation::Pdf417ErrorLevel get_Pdf417ErrorLevel () const
 Gets 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. More...
 
void set_Pdf417ErrorLevel (Aspose::BarCode::Generation::Pdf417ErrorLevel value)
 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. More...
 
bool get_Pdf417Truncate () const
 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. More...
 
void set_Pdf417Truncate (bool value)
 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. More...
 
int32_t get_Columns () const
 Columns count. More...
 
void set_Columns (int32_t value)
 Columns count. More...
 
int32_t get_Rows () const
 Rows count. More...
 
void set_Rows (int32_t value)
 Rows count. More...
 
float get_AspectRatio ()
 Height/Width ratio of 2D BarCode module. More...
 
void set_AspectRatio (float value)
 Height/Width ratio of 2D BarCode module. More...
 
int32_t get_Pdf417MacroFileID () const
 MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode) More...
 
void set_Pdf417MacroFileID (int32_t value)
 MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode) More...
 
int32_t get_Pdf417MacroSegmentID () const
 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) More...
 
void set_Pdf417MacroSegmentID (int32_t value)
 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) More...
 
int32_t get_Pdf417MacroSegmentsCount () const
 MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode) More...
 
void set_Pdf417MacroSegmentsCount (int32_t value)
 MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode) More...
 
System::String get_Pdf417MacroFileName () const
 MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode) More...
 
void set_Pdf417MacroFileName (System::String value)
 MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode) More...
 
System::DateTime get_Pdf417MacroTimeStamp () const
 MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode) More...
 
void set_Pdf417MacroTimeStamp (System::DateTime value)
 MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode) More...
 
System::String get_Pdf417MacroSender () const
 MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode) More...
 
void set_Pdf417MacroSender (System::String value)
 MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode) More...
 
System::String get_Pdf417MacroAddressee () const
 MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode) More...
 
void set_Pdf417MacroAddressee (System::String value)
 MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode) More...
 
int32_t get_Pdf417MacroFileSize () const
 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. More...
 
void set_Pdf417MacroFileSize (int32_t value)
 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. More...
 
int32_t get_Pdf417MacroChecksum () const
 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 More...
 
void set_Pdf417MacroChecksum (int32_t value)
 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 More...
 
System::SharedPtr< System::Text::Encodingget_CodeTextEncoding () const
 Gets the encoding of codetext. Default value: UTF-8 More...
 
void set_CodeTextEncoding (System::SharedPtr< System::Text::Encoding > value)
 Sets the encoding of codetext. Default value: UTF-8 More...
 
ECIEncodings get_Pdf417ECIEncoding () const
 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. More...
 
void set_Pdf417ECIEncoding (ECIEncodings value)
 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. More...
 
ECIEncodings get_Pdf417MacroECIEncoding () const
 Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. More...
 
void set_Pdf417MacroECIEncoding (ECIEncodings value)
 Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. More...
 
Aspose::BarCode::Generation::Pdf417MacroTerminator get_Pdf417MacroTerminator () const
 Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. More...
 
void set_Pdf417MacroTerminator (Aspose::BarCode::Generation::Pdf417MacroTerminator value)
 Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. More...
 
bool get_IsReaderInitialization () const
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
void set_IsReaderInitialization (bool value)
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
MacroCharacter get_MacroCharacters () const
 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. More...
 
void set_MacroCharacters (MacroCharacter value)
 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. More...
 
bool get_IsLinked () const
 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 More...
 
void set_IsLinked (bool value)
 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 More...
 
bool get_IsCode128Emulation () const
 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 More...
 
void set_IsCode128Emulation (bool value)
 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 More...
 
System::String ToString () const override
 Returns a human-readable string representation of this Pdf417Parameters. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

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.

These samples show how to encode UCC/EAN-128 non Linked modes in GS1MicroPdf417

[C#]
//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);

Member Function Documentation

◆ get_AspectRatio()

float Aspose::BarCode::Generation::Pdf417Parameters::get_AspectRatio ( )

Height/Width ratio of 2D BarCode module.

◆ get_CodeTextEncoding()

System::SharedPtr<System::Text::Encoding> Aspose::BarCode::Generation::Pdf417Parameters::get_CodeTextEncoding ( ) const

Gets the encoding of codetext. Default value: UTF-8

Deprecated:
This property is obsolete and will be removed in future releases. Unicode symbols detection and encoding will be processed in Auto mode with Extended Channel Interpretation charset designator. Using of own encodings requires manual CodeText encoding into byte[] array. False

◆ get_Columns()

int32_t Aspose::BarCode::Generation::Pdf417Parameters::get_Columns ( ) const

Columns count.

◆ get_IsCode128Emulation()

bool Aspose::BarCode::Generation::Pdf417Parameters::get_IsCode128Emulation ( ) const

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

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

[C#]
//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());

◆ get_IsLinked()

bool Aspose::BarCode::Generation::Pdf417Parameters::get_IsLinked ( ) const

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

These samples show how to encode "Linked" UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes

[C#]
//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());

◆ get_IsReaderInitialization()

bool Aspose::BarCode::Generation::Pdf417Parameters::get_IsReaderInitialization ( ) const

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.

◆ get_MacroCharacters()

MacroCharacter Aspose::BarCode::Generation::Pdf417Parameters::get_MacroCharacters ( ) const

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.

These samples show how to encode Macro Characters in MicroPdf417

[C#]
//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);

◆ get_Pdf417CompactionMode()

Aspose::BarCode::Generation::Pdf417CompactionMode Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417CompactionMode ( ) const

Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.Auto.

◆ get_Pdf417ECIEncoding()

ECIEncodings Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417ECIEncoding ( ) const

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.

◆ get_Pdf417ErrorLevel()

Aspose::BarCode::Generation::Pdf417ErrorLevel Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417ErrorLevel ( ) const

Gets 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.

◆ get_Pdf417MacroAddressee()

System::String Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroAddressee ( ) const

MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

◆ get_Pdf417MacroChecksum()

int32_t Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroChecksum ( ) const

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

◆ get_Pdf417MacroECIEncoding()

ECIEncodings Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroECIEncoding ( ) const

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

◆ get_Pdf417MacroFileID()

int32_t Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroFileID ( ) const

MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode)

◆ get_Pdf417MacroFileName()

System::String Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroFileName ( ) const

MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

◆ get_Pdf417MacroFileSize()

int32_t Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroFileSize ( ) const

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.

◆ get_Pdf417MacroSegmentID()

int32_t Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroSegmentID ( ) const

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)

◆ get_Pdf417MacroSegmentsCount()

int32_t Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroSegmentsCount ( ) const

MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)

◆ get_Pdf417MacroSender()

System::String Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroSender ( ) const

MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

◆ get_Pdf417MacroTerminator()

Aspose::BarCode::Generation::Pdf417MacroTerminator Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroTerminator ( ) const

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

◆ get_Pdf417MacroTimeStamp()

System::DateTime Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417MacroTimeStamp ( ) const

MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

◆ get_Pdf417Truncate()

bool Aspose::BarCode::Generation::Pdf417Parameters::get_Pdf417Truncate ( ) const

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.

◆ get_Rows()

int32_t Aspose::BarCode::Generation::Pdf417Parameters::get_Rows ( ) const

Rows count.

◆ set_AspectRatio()

void Aspose::BarCode::Generation::Pdf417Parameters::set_AspectRatio ( float  value)

Height/Width ratio of 2D BarCode module.

◆ set_CodeTextEncoding()

void Aspose::BarCode::Generation::Pdf417Parameters::set_CodeTextEncoding ( System::SharedPtr< System::Text::Encoding value)

Sets the encoding of codetext. Default value: UTF-8

Deprecated:
This property is obsolete and will be removed in future releases. Unicode symbols detection and encoding will be processed in Auto mode with Extended Channel Interpretation charset designator. Using of own encodings requires manual CodeText encoding into byte[] array. False

◆ set_Columns()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Columns ( int32_t  value)

Columns count.

◆ set_IsCode128Emulation()

void Aspose::BarCode::Generation::Pdf417Parameters::set_IsCode128Emulation ( bool  value)

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

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

[C#]
//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());

◆ set_IsLinked()

void Aspose::BarCode::Generation::Pdf417Parameters::set_IsLinked ( bool  value)

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

These samples show how to encode "Linked" UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes

[C#]
//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());

◆ set_IsReaderInitialization()

void Aspose::BarCode::Generation::Pdf417Parameters::set_IsReaderInitialization ( bool  value)

Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.

◆ set_MacroCharacters()

void Aspose::BarCode::Generation::Pdf417Parameters::set_MacroCharacters ( MacroCharacter  value)

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.

These samples show how to encode Macro Characters in MicroPdf417

[C#]
//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);

◆ set_Pdf417CompactionMode()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417CompactionMode ( Aspose::BarCode::Generation::Pdf417CompactionMode  value)

Pdf417 symbology type of BarCode's compaction mode. Default value: Pdf417CompactionMode.Auto.

◆ set_Pdf417ECIEncoding()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417ECIEncoding ( ECIEncodings  value)

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.

◆ set_Pdf417ErrorLevel()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417ErrorLevel ( Aspose::BarCode::Generation::Pdf417ErrorLevel  value)

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.

◆ set_Pdf417MacroAddressee()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroAddressee ( System::String  value)

MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode)

◆ set_Pdf417MacroChecksum()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroChecksum ( int32_t  value)

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

◆ set_Pdf417MacroECIEncoding()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroECIEncoding ( ECIEncodings  value)

Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

◆ set_Pdf417MacroFileID()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroFileID ( int32_t  value)

MacroPdf417 barcode's file ID (Required field). MicroPDF417 barcode's file ID (Required field for Structured Append mode)

◆ set_Pdf417MacroFileName()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroFileName ( System::String  value)

MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode)

◆ set_Pdf417MacroFileSize()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroFileSize ( int32_t  value)

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.

◆ set_Pdf417MacroSegmentID()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroSegmentID ( int32_t  value)

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)

◆ set_Pdf417MacroSegmentsCount()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroSegmentsCount ( int32_t  value)

MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode)

◆ set_Pdf417MacroSender()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroSender ( System::String  value)

MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode)

◆ set_Pdf417MacroTerminator()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroTerminator ( Aspose::BarCode::Generation::Pdf417MacroTerminator  value)

Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.

◆ set_Pdf417MacroTimeStamp()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417MacroTimeStamp ( System::DateTime  value)

MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode)

◆ set_Pdf417Truncate()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Pdf417Truncate ( bool  value)

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.

◆ set_Rows()

void Aspose::BarCode::Generation::Pdf417Parameters::set_Rows ( int32_t  value)

Rows count.

◆ ToString()

System::String Aspose::BarCode::Generation::Pdf417Parameters::ToString ( ) const
overridevirtual

Returns a human-readable string representation of this Pdf417Parameters.

Returns
A string that represents this Pdf417Parameters.

Reimplemented from System::Object.