Pdf417Parameters

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. These samples show how to encode UCC/EAN-128 non Linked modes in GS1MicroPdf417

new Pdf417Parameters()

Example:

# 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());
}

Methods

NameDescription
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
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 corr
getMacroCharacters()Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with Micro
getMacroPdf417Addressee()MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured A
getMacroPdf417Checksum()MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode)
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
getMacroPdf417SegmentID()MacroPdf417 barcode’s segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode’s
getMacroPdf417SegmentsCount()MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured A
getMacroPdf417Sender()MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append
getMacroPdf417Terminator()Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD
getMacroPdf417TimeStamp()MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mo
getPdf417CompactionMode()Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO.
getPdf417ECIEncoding() (deprecated)Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for
getPdf417EncodeMode()Identifies Pdf417 encode mode. Default value: Auto.
getPdf417ErrorLevel() (deprecated)Gets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error corr
getPdf417MacroAddressee() (deprecated)Gets macro Pdf417 barcode addressee name.
getPdf417MacroChecksum() (deprecated)Gets macro Pdf417 barcode checksum.
getPdf417MacroECIEncoding() (deprecated)Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
getPdf417MacroFileID() (deprecated)Getsmacro Pdf417 barcode’s file ID. Used for MacroPdf417.
getPdf417MacroFileName() (deprecated)Gets macro Pdf417 barcode file name.
getPdf417MacroFileSize() (deprecated)Gets macro Pdf417 file size.
getPdf417MacroSegmentID() (deprecated)Gets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1.
getPdf417MacroSegmentsCount() (deprecated)Gets macro Pdf417 barcode segments count.
getPdf417MacroSender() (deprecated)Gets macro Pdf417 barcode sender name.
getPdf417MacroTerminator() (deprecated)Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD
getPdf417MacroTimeStamp() (deprecated)Gets macro Pdf417 barcode time stamp.
getPdf417Truncate() (deprecated)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
getTruncate()Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicato
isCode128Emulation()Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and
isLinked()Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907
isReaderInitialization()Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization
setAspectRatio()Height/Width ratio of 2D BarCode module.
setCode128Emulation()Can be used only with MicroPdf417 and encodes Code 128 emulation modes Can encode FNC1 in second position modes 908 and
setColumns()Columns count.
setECIEncoding()Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for
setEncodeMode()Identifies Pdf417 encode mode. Default value: Auto.
setErrorLevel(value)Sets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error corr
setLinked()Defines linked modes with GS1MicroPdf417, MicroPdf417 and Pdf417 barcodes With GS1MicroPdf417 symbology encodes 906, 907
setMacroCharacters()Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. Can be used only with Micro
setMacroPdf417Addressee()MacroPdf417 barcode addressee name (optional field). MicroPDF417 barcode addressee name (optional field for Structured A
setMacroPdf417Checksum()MacroPdf417 barcode checksum (optional field). MicroPDF417 barcode checksum (optional field for Structured Append mode)
setMacroPdf417ECIEncoding()Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
setMacroPdf417FileID()MacroPdf417 barcode’s file ID (Required field). MicroPDF417 barcode’s file ID (Required field for Structured Append mode
setMacroPdf417FileName()MacroPdf417 barcode file name (optional field). MicroPDF417 barcode file name (optional field for Structured Append mode
setMacroPdf417FileSize()MacroPdf417 file size (optional field). MicroPDF417 file size (optional field for Structured Append mode) The file size
setMacroPdf417SegmentID()MacroPdf417 barcode’s segment ID (Required field), which starts from 0, to MacroSegmentsCount - 1. MicroPDF417 barcode’s
setMacroPdf417SegmentsCount()MacroPdf417 barcode segments count (optional field). MicroPDF417 barcode segments count (optional field for Structured A
setMacroPdf417Sender()MacroPdf417 barcode sender name (optional field). MicroPDF417 barcode sender name (optional field for Structured Append
setMacroPdf417Terminator()Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD
setMacroPdf417TimeStamp()MacroPdf417 barcode time stamp (optional field). MicroPDF417 barcode time stamp (optional field for Structured Append mo
setPdf417CompactionMode()Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO.
setPdf417ECIEncoding() (deprecated)Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for
setPdf417EncodeMode() (deprecated)Identifies Pdf417 encode mode. Default value: Auto.
setPdf417ErrorLevel() (deprecated)Sets Pdf417 symbology type of BarCode’s error correction level ranging from level0 to level8, level0 means no error corr
setPdf417MacroAddressee() (deprecated)Sets macro Pdf417 barcode addressee name.
setPdf417MacroChecksum(value) (deprecated)Sets macro Pdf417 barcode checksum.
setPdf417MacroECIEncoding() (deprecated)Extended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
setPdf417MacroFileID() (deprecated)Sets macro Pdf417 barcode’s file ID. Used for MacroPdf417.
setPdf417MacroFileName() (deprecated)Sets macro Pdf417 barcode file name.
setPdf417MacroFileSize(value) (deprecated)Sets macro Pdf417 file size.
setPdf417MacroSegmentID() (deprecated)Sets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1.
setPdf417MacroSegmentsCount() (deprecated)Sets macro Pdf417 barcode segments count.
setPdf417MacroSender() (deprecated)Sets macro Pdf417 barcode sender name.
setPdf417MacroTerminator() (deprecated)Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PD
setPdf417MacroTimeStamp() (deprecated)Sets macro Pdf417 barcode time stamp.
setPdf417Truncate() (deprecated)Whether Pdf417 symbology type of BarCode is truncated (to reduce space).
setReaderInitialization(value)Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization
setRows()Rows count.
setStructuredAppendModeBarcodeId()Identifies the ID of the DotCode structured append mode barcode. ID starts from 1 and must be less or equal to barcodes
setTruncate()Whether Pdf417 symbology type of BarCode is truncated (to reduce space). Also known as CompactPDF417. Rigth row indicato
toString()Returns a human-readable string representation of this Pdf417Parameters.

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.

Returns: 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. These samples show how to encode Macro Characters in MicroPdf417

Example:

# Encodes MicroPdf417 with 05 Macro the string: "[)>\u001E05\u001Dabcde1234\u001E\u0004"
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "abcde1234");
generator.getParameters().getBarcode().getPdf417().setMacroCharacters(MacroCharacter.MACRO_05);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];
    console.log( result.getCodeText());
}

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()

Deprecated. See method description for replacement.

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()

Deprecated. See method description for replacement.

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()

Deprecated. See method description for replacement.

Gets macro Pdf417 barcode addressee name.

getPdf417MacroChecksum()

Deprecated. See method description for replacement.

Gets macro Pdf417 barcode checksum.

Returns: The checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

getPdf417MacroECIEncoding()

Deprecated. See method description for replacement.

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

getPdf417MacroFileID()

Deprecated. See method description for replacement.

Getsmacro Pdf417 barcode’s file ID. Used for MacroPdf417.

getPdf417MacroFileName()

Deprecated. See method description for replacement.

Gets macro Pdf417 barcode file name.

getPdf417MacroFileSize()

Deprecated. See method description for replacement.

Gets macro Pdf417 file size.

Returns: The file size field contains the size in bytes of the entire source file.

getPdf417MacroSegmentID()

Deprecated. See method description for replacement.

Gets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1.

getPdf417MacroSegmentsCount()

Deprecated. See method description for replacement.

Gets macro Pdf417 barcode segments count.

getPdf417MacroSender()

Deprecated. See method description for replacement.

Gets macro Pdf417 barcode sender name.

getPdf417MacroTerminator()

Deprecated. See method description for replacement.

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

getPdf417MacroTimeStamp()

Deprecated. See method description for replacement.

Gets macro Pdf417 barcode time stamp.

getPdf417Truncate()

Deprecated. See method description for replacement.

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.

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

Example:

# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "a", mode 908.
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "a\u001d1222322323");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];
    console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}

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 These samples show how to encode “Linked” UCC/EAN-128 modes in GS1MicroPdf417 and Linkage Flag (918) in MicroPdf417 and Pdf417 barcodes

Example:

# Encodes GS1 Linked mode 912 with date field AI 11 (Production date) and AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(11)991231(10)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
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() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}

isReaderInitialization()

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

Returns: boolean value

setAspectRatio()

Height/Width ratio of 2D BarCode module.

setCode128Emulation()

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

Example:

# Encodes MicroPdf417 in Code 128 emulation mode with FNC1 in second position and Application Indicator "a", mode 908.
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "a\u001d1222322323");
generator.getParameters().getBarcode().getPdf417().setCode128Emulation(true);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];
    console.log(result.getCodeText() + " IsCode128Emulation:" + result.getExtended().getPdf417().isCode128Emulation());
}

setColumns()

Columns count.

setECIEncoding()

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()

Identifies Pdf417 encode mode. Default value: Auto.

setErrorLevel(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.

ParameterDescription
valuePdf417 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()

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

Example:

# Encodes GS1 Linked mode 912 with date field AI 11 (Production date) and AI 10 (Lot number)
let generator = new BarcodeGenerator(EncodeTypes.GS_1_MICRO_PDF_417, "(11)991231(10)ABCD");
generator.getParameters().getBarcode().getPdf417().setLinked(true);
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() + " IsLinked:" + result.getExtended().getPdf417().isLinked();
}

setMacroCharacters()

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

Example:

# Encodes MicroPdf417 with 05 Macro the string: "[)>\u001E05\u001Dabcde1234\u001E\u0004"
let generator = new BarcodeGenerator(EncodeTypes.MICRO_PDF_417, "abcde1234");
generator.getParameters().getBarcode().getPdf417().setMacroCharacters(MacroCharacter.MACRO_05);
let reader = new BarCodeReader(generator.generateBarCodeImage(BarcodeImageFormat.PNG), null, DecodeType.MICRO_PDF_417);
let results = reader.readBarCodes();
for(let i = 0; i < results.length; i++)
{
    let result = results[i];
    console.log( result.getCodeText());
}

setMacroPdf417Addressee()

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

setMacroPdf417Checksum()

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()

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

setMacroPdf417FileID()

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

setMacroPdf417FileName()

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

setMacroPdf417FileSize()

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()

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()

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

setMacroPdf417Sender()

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

setMacroPdf417Terminator()

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

setMacroPdf417TimeStamp()

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

setPdf417CompactionMode()

Pdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO.

setPdf417ECIEncoding()

Deprecated. See method description for replacement.

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()

Deprecated. See method description for replacement.

Identifies Pdf417 encode mode. Default value: Auto.

setPdf417ErrorLevel()

Deprecated. See method description for replacement.

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()

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode addressee name.

setPdf417MacroChecksum(value)

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode checksum.

ParameterDescription
valueThe checksum field contains the value of the 16-bit (2 bytes) CRC checksum using the CCITT-16 polynomial.

setPdf417MacroECIEncoding()

Deprecated. See method description for replacement.

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

setPdf417MacroFileID()

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode’s file ID. Used for MacroPdf417.

setPdf417MacroFileName()

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode file name.

setPdf417MacroFileSize(value)

Deprecated. See method description for replacement.

Sets macro Pdf417 file size.

ParameterDescription
valueThe file size field contains the size in bytes of the entire source file.

setPdf417MacroSegmentID()

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode’s segment ID, which starts from 0, to MacroSegmentsCount - 1.

setPdf417MacroSegmentsCount()

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode segments count.

setPdf417MacroSender()

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode sender name.

setPdf417MacroTerminator()

Deprecated. See method description for replacement.

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

setPdf417MacroTimeStamp()

Deprecated. See method description for replacement.

Sets macro Pdf417 barcode time stamp.

setPdf417Truncate()

Deprecated. See method description for replacement.

Whether Pdf417 symbology type of BarCode is truncated (to reduce space).

setReaderInitialization(value)

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

ParameterDescription
value

setRows()

Rows count.

setStructuredAppendModeBarcodeId()

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()

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.

Returns: A string that represents this Pdf417Parameters.