Pdf417Parameters
Contents
[
Hide
]Pdf417Parameters class
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.
public class Pdf417Parameters : joint.BaseJavaClass
Constructors
| Name | Description |
|---|---|
| Pdf417Parameters(object) | Initializes a new instance of the Pdf417Parameters class. |
Methods
| Name | Description |
|---|---|
| getAspectRatio | Height/Width ratio of 2D BarCode module. |
| getColumns | Columns count. |
| getECIEncoding | 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. |
| getEncodeMode | Identifies Pdf417 encode mode. Default value: Auto. |
| getErrorLevel | 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. |
| getMacroCharacters | 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. |
| getMacroPdf417Addressee | MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode). |
| getMacroPdf417Checksum | 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. |
| getMacroPdf417ECIEncoding | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| getMacroPdf417FileID | MacroPdf417 barcode’s file ID (Required field). MicroPDF417 barcode’s file ID (Required field for Structured Append mode). |
| getMacroPdf417FileName | MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode). |
| getMacroPdf417FileSize | 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. |
| getMacroPdf417SegmentID | 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). |
| getMacroPdf417SegmentsCount | MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode). |
| getMacroPdf417Sender | MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode). |
| getMacroPdf417Terminator | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. |
| getMacroPdf417TimeStamp | MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode). |
| getPdf417CompactionMode | Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO. |
| getPdf417ECIEncoding | Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings. |
| getPdf417EncodeMode | Identifies Pdf417 encode mode. Default value: Auto. |
| getPdf417ErrorLevel | 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. |
| getPdf417MacroAddressee | Gets macro Pdf417 barcode addressee name. |
| getPdf417MacroChecksum | Gets macro Pdf417 barcode checksum. |
| getPdf417MacroECIEncoding | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| getPdf417MacroFileID | Getsmacro Pdf417 barcode’s file ID. Used for MacroPdf417. |
| getPdf417MacroFileName | Gets macro Pdf417 barcode file name. |
| getPdf417MacroFileSize | Gets macro Pdf417 file size. |
| getPdf417MacroSegmentID | Gets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1. |
| getPdf417MacroSegmentsCount | Gets macro Pdf417 barcode segments count. |
| getPdf417MacroSender | Gets macro Pdf417 barcode sender name. |
| getPdf417MacroTerminator | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. |
| getPdf417MacroTimeStamp | Gets macro Pdf417 barcode time stamp. |
| getPdf417Truncate | Whether Pdf417 symbology type of BarCode is truncated (to reduce space). |
| getRows | Rows count. |
| getStructuredAppendModeBarcodeId | Identifies the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes count. Default value is -1. |
| getTruncate | 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. |
| init | |
| 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. |
| 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. |
| isReaderInitialization | Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. |
| setAspectRatio(object) | Height/Width ratio of 2D BarCode module. |
| setCode128Emulation(object) | 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. |
| setColumns(object) | Columns count. |
| setECIEncoding(object) | 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. |
| setEncodeMode(object) | Identifies Pdf417 encode mode. Default value: Auto. |
| setErrorLevel(object) | 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. |
| setLinked(object) | 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. |
| setMacroCharacters(object) | 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. |
| setMacroPdf417Addressee(object) | MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured Append mode). |
| setMacroPdf417Checksum(object) | 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. |
| setMacroPdf417ECIEncoding(object) | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| setMacroPdf417FileID(object) | MacroPdf417 barcode’s file ID (Required field). MicroPDF417 barcode’s file ID (Required field for Structured Append mode). |
| setMacroPdf417FileName(object) | MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode). |
| setMacroPdf417FileSize(object) | 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. |
| setMacroPdf417SegmentID(object) | 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). |
| setMacroPdf417SegmentsCount(object) | MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured Append mode). |
| setMacroPdf417Sender(object) | MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append mode). |
| setMacroPdf417Terminator(object) | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. |
| setMacroPdf417TimeStamp(object) | MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mode). |
| setPdf417CompactionMode(object) | Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO. |
| setPdf417ECIEncoding(object) | Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol. Current implementation consists all well known charset encodings. |
| setPdf417EncodeMode(object) | Identifies Pdf417 encode mode. Default value: Auto. |
| setPdf417ErrorLevel(object) | 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. |
| setPdf417MacroAddressee(object) | Sets macro Pdf417 barcode addressee name. |
| setPdf417MacroChecksum(object) | Sets macro Pdf417 barcode checksum. |
| setPdf417MacroECIEncoding(object) | Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields. |
| setPdf417MacroFileID(object) | Sets macro Pdf417 barcode’s file ID. Used for MacroPdf417. |
| setPdf417MacroFileName(object) | Sets macro Pdf417 barcode file name. |
| setPdf417MacroFileSize(object) | Sets macro Pdf417 file size. |
| setPdf417MacroSegmentID(object) | Sets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1. |
| setPdf417MacroSegmentsCount(object) | Sets macro Pdf417 barcode segments count. |
| setPdf417MacroSender(object) | Sets macro Pdf417 barcode sender name. |
| setPdf417MacroTerminator(object) | Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417. |
| setPdf417MacroTimeStamp(object) | Sets macro Pdf417 barcode time stamp. |
| setPdf417Truncate(object) | Whether Pdf417 symbology type of BarCode is truncated (to reduce space). |
| setReaderInitialization(object) | Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. |
| setRows(object) | Rows count. |
| setStructuredAppendModeBarcodeId(object) | Identifies the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes count. Default value is -1. |
| setTruncate(object) | 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. |
| toString | Returns a human-readable string representation of this Pdf417Parameters. |
Examples
Encodes GS1 UCC/EAN-128 non Linked mode 905 with AI 01 (GTIN)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(01)12345678901231");
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
let result = results[i];
console.log( result.getCodeText());
}
Encodes GS1 UCC/EAN-128 non Linked modes 903, 904 with any AI
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(241)123456789012345(241)ABCD123456789012345");
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.GS_1_MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
let result = results[i];
console.log( result.getCodeText());
}
</pre>
</pre>
</p>
See Also
- assembly Aspose.BarCode