Pdf417Parameters

Pdf417Parameters class

Module: aspose_barcode.generation.pdf_417_parameters

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

Constructors

NameDescription
init

Methods

NameReturn TypeStaticDescription
strstrNoReturns a human-readable string representation of this Pdf417Parameters.
macro_pdf_417_eci_encodingintNo
macro_pdf_417_eci_encodingintNoExtended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
macro_pdf_417_eci_encodingNoneNo
macro_pdf_417_eci_encodingNoneNoExtended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.

Properties

NameTypeDescription
aspect_ratiofloatHeight/Width ratio of 2D BarCode module.
code_128_emulationboolCan 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.
columnsintColumns count.
eci_encodingint
encode_modeint
error_levelPdf417ErrorLevel
linkedboolDefines 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.
macro_charactersintMacro 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.
macro_pdf_417_addresseeOptional[str]Gets macro Pdf417 barcode addressee name.
macro_pdf_417_checksumintGets macro Pdf417 barcode checksum.
macro_pdf_417_file_idintGets macro Pdf417 barcode’s file ID. Used for MacroPdf417.
macro_pdf_417_file_nameOptional[str]Gets macro Pdf417 barcode file name.
macro_pdf_417_file_sizeintGets macro Pdf417 file size.
macro_pdf_417_segment_idintGets macro Pdf417 barcode’s segment ID.
macro_pdf_417_segments_countintGets macro Pdf417 barcode segments count.
macro_pdf_417_senderOptional[str]Gets macro Pdf417 barcode sender name.
macro_pdf_417_terminatorPdf417MacroTerminatorUsed to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
macro_pdf_417_time_stampdatetimeGets macro Pdf417 barcode time stamp.
pdf_417_compaction_modePdf417CompactionModePdf417 symbology type of BarCode’s compaction mode. Default value: Pdf417CompactionMode.AUTO.
pdf_417_eci_encodingintExtended 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.
pdf_417_encode_modePdf417EncodeModeGets Pdf417 encode mode. Default value: Auto.
pdf_417_error_levelPdf417ErrorLevelGets Pdf417 symbology type of BarCode’s error correction level.
pdf_417_macro_addresseeOptional[str]Gets macro Pdf417 barcode addressee name.
pdf_417_macro_checksumintGets macro Pdf417 barcode checksum.
pdf_417_macro_eci_encodingintExtended Channel Interpretation Identifiers. Applies for Macro PDF417 text fields.
pdf_417_macro_file_idintGets macro Pdf417 barcode’s file ID. Used for MacroPdf417.
pdf_417_macro_file_nameOptional[str]Gets macro Pdf417 barcode file name.
pdf_417_macro_file_sizeintGets macro Pdf417 file size.
pdf_417_macro_segment_idintGets macro Pdf417 barcode’s segment ID.
pdf_417_macro_segments_countintGets macro Pdf417 barcode segments count.
pdf_417_macro_senderOptional[str]Gets macro Pdf417 barcode sender name.
pdf_417_macro_terminatorintUsed to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
pdf_417_macro_time_stampdatetimeGets macro Pdf417 barcode time stamp.
pdf_417_truncateboolWhether Pdf417 symbology type of BarCode is truncated (to reduce space).
reader_initializationboolUsed to instruct the reader to interpret the data contained within the symbol as programming for reader initialization.
rowsintRows count.
structured_append_mode_barcode_idint
truncatebool