Aspose.Barcode for Python via Java Generation and Recognition API docs
asposebarcode.Generation.Pdf417Parameters Class Reference

PDF417 parameters. More...

Inherits asposebarcode.Assist.BaseJavaClass.

Public Member Functions

def __init__ (self, javaClass)
 
def init (self)
 
def getPdf417CompactionMode (self)
 Pdf417 symbology type of BarCode's compaction mode. More...
 
def setPdf417CompactionMode (self, value)
 Pdf417 symbology type of BarCode's compaction mode. More...
 
def getPdf417ErrorLevel (self)
 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. More...
 
def setPdf417ErrorLevel (self, value)
 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. More...
 
def getPdf417Truncate (self)
 Whether Pdf417 symbology type of BarCode is truncated (to reduce space). More...
 
def setPdf417Truncate (self, value)
 Whether Pdf417 symbology type of BarCode is truncated (to reduce space). More...
 
def getColumns (self)
 Columns count. More...
 
def setColumns (self, value)
 Columns count. More...
 
def getRows (self)
 Rows count. More...
 
def setRows (self, value)
 Rows count. More...
 
def getAspectRatio (self)
 Height/Width ratio of 2D BarCode module. More...
 
def setAspectRatio (self, value)
 Height/Width ratio of 2D BarCode module. More...
 
def getPdf417MacroFileID (self)
 Getsmacro Pdf417 barcode's file ID. More...
 
def setPdf417MacroFileID (self, value)
 Sets macro Pdf417 barcode's file ID. More...
 
def getPdf417MacroSegmentID (self)
 Gets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1. More...
 
def setPdf417MacroSegmentID (self, value)
 Sets macro Pdf417 barcode's segment ID, which starts from 0, to MacroSegmentsCount - 1. More...
 
def getPdf417MacroSegmentsCount (self)
 Gets macro Pdf417 barcode segments count. More...
 
def setPdf417MacroSegmentsCount (self, value)
 Sets macro Pdf417 barcode segments count. More...
 
def getPdf417MacroFileName (self)
 Gets macro Pdf417 barcode file name. More...
 
def setPdf417MacroFileName (self, value)
 Sets macro Pdf417 barcode file name. More...
 
def getPdf417MacroTimeStamp (self)
 Gets macro Pdf417 barcode time stamp. More...
 
def setPdf417MacroTimeStamp (self, value)
 Sets macro Pdf417 barcode time stamp. More...
 
def getPdf417MacroSender (self)
 Gets macro Pdf417 barcode sender name. More...
 
def setPdf417MacroSender (self, value)
 Sets macro Pdf417 barcode sender name. More...
 
def getPdf417MacroAddressee (self)
 Gets macro Pdf417 barcode addressee name. More...
 
def setPdf417MacroAddressee (self, value)
 Sets macro Pdf417 barcode addressee name. More...
 
def getPdf417MacroFileSize (self)
 Gets or sets macro Pdf417 file size. More...
 
def setPdf417MacroFileSize (self, value)
 Gets or sets macro Pdf417 file size. More...
 
def getPdf417MacroChecksum (self)
 Gets macro Pdf417 barcode checksum. More...
 
def setPdf417MacroChecksum (self, value)
 Sets macro Pdf417 barcode checksum. More...
 
def getCodeTextEncoding (self)
 Gets the encoding of codetext. More...
 
def setCodeTextEncoding (self, value)
 Sets the encoding of codetext. More...
 
def getPdf417ECIEncoding (self)
 Extended Channel Interpretation Identifiers. More...
 
def setPdf417ECIEncoding (self, value)
 Extended Channel Interpretation Identifiers. More...
 
def getPdf417MacroECIEncoding (self)
 Extended Channel Interpretation Identifiers. More...
 
def setPdf417MacroECIEncoding (self, value)
 Extended Channel Interpretation Identifiers. More...
 
def isReaderInitialization (self)
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
def setReaderInitialization (self, value)
 Used to instruct the reader to interpret the data contained within the symbol as programming for reader initialization. More...
 
def getCode128Emulation (self)
 Function codeword for Code 128 emulation. More...
 
def setCode128Emulation (self, value)
 Function codeword for Code 128 emulation. More...
 
def toString (self)
 Returns a human-readable string representation of this Pdf417Parameters. More...
 
- Public Member Functions inherited from asposebarcode.Assist.BaseJavaClass
def getJavaClass (self)
 
def setJavaClass (self, javaClass)
 
def getJavaClassName (self)
 
def isNull (self)
 
def printJavaClassName (self)
 

Additional Inherited Members

- Public Attributes inherited from asposebarcode.Assist.BaseJavaClass
 javaClass
 
 javaClassName
 

Detailed Description

PDF417 parameters.

Constructor & Destructor Documentation

◆ __init__()

def asposebarcode.Generation.Pdf417Parameters.__init__ (   self,
  javaClass 
)

Member Function Documentation

◆ getAspectRatio()

def asposebarcode.Generation.Pdf417Parameters.getAspectRatio (   self)

Height/Width ratio of 2D BarCode module.

◆ getCode128Emulation()

def asposebarcode.Generation.Pdf417Parameters.getCode128Emulation (   self)

Function codeword for Code 128 emulation.

Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.

◆ getCodeTextEncoding()

def asposebarcode.Generation.Pdf417Parameters.getCodeTextEncoding (   self)

Gets the encoding of codetext.

Default value: UTF-8

◆ getColumns()

def asposebarcode.Generation.Pdf417Parameters.getColumns (   self)

Columns count.

◆ getPdf417CompactionMode()

def asposebarcode.Generation.Pdf417Parameters.getPdf417CompactionMode (   self)

Pdf417 symbology type of BarCode's compaction mode.

Default value: Pdf417CompactionMode.AUTO.

◆ getPdf417ECIEncoding()

def asposebarcode.Generation.Pdf417Parameters.getPdf417ECIEncoding (   self)

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.

◆ getPdf417ErrorLevel()

def asposebarcode.Generation.Pdf417Parameters.getPdf417ErrorLevel (   self)

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.

◆ getPdf417MacroAddressee()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroAddressee (   self)

Gets macro Pdf417 barcode addressee name.

◆ getPdf417MacroChecksum()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroChecksum (   self)

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

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroECIEncoding (   self)

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

◆ getPdf417MacroFileID()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroFileID (   self)

Getsmacro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ getPdf417MacroFileName()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroFileName (   self)

Gets macro Pdf417 barcode file name.

◆ getPdf417MacroFileSize()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroFileSize (   self)

Gets or sets macro Pdf417 file size.

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

◆ getPdf417MacroSegmentID()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroSegmentID (   self)

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

◆ getPdf417MacroSegmentsCount()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroSegmentsCount (   self)

Gets macro Pdf417 barcode segments count.

◆ getPdf417MacroSender()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroSender (   self)

Gets macro Pdf417 barcode sender name.

◆ getPdf417MacroTimeStamp()

def asposebarcode.Generation.Pdf417Parameters.getPdf417MacroTimeStamp (   self)

Gets macro Pdf417 barcode time stamp.

◆ getPdf417Truncate()

def asposebarcode.Generation.Pdf417Parameters.getPdf417Truncate (   self)

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

◆ getRows()

def asposebarcode.Generation.Pdf417Parameters.getRows (   self)

Rows count.

◆ init()

def asposebarcode.Generation.Pdf417Parameters.init (   self)

◆ isReaderInitialization()

def asposebarcode.Generation.Pdf417Parameters.isReaderInitialization (   self)

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

Returns

◆ setAspectRatio()

def asposebarcode.Generation.Pdf417Parameters.setAspectRatio (   self,
  value 
)

Height/Width ratio of 2D BarCode module.

◆ setCode128Emulation()

def asposebarcode.Generation.Pdf417Parameters.setCode128Emulation (   self,
  value 
)

Function codeword for Code 128 emulation.

Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.

◆ setCodeTextEncoding()

def asposebarcode.Generation.Pdf417Parameters.setCodeTextEncoding (   self,
  value 
)

Sets the encoding of codetext.

Default value: UTF-8

◆ setColumns()

def asposebarcode.Generation.Pdf417Parameters.setColumns (   self,
  value 
)

Columns count.

◆ setPdf417CompactionMode()

def asposebarcode.Generation.Pdf417Parameters.setPdf417CompactionMode (   self,
  value 
)

Pdf417 symbology type of BarCode's compaction mode.

Default value: Pdf417CompactionMode.AUTO.

◆ setPdf417ECIEncoding()

def asposebarcode.Generation.Pdf417Parameters.setPdf417ECIEncoding (   self,
  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. Current implementation consists all well known charset encodings.

◆ setPdf417ErrorLevel()

def asposebarcode.Generation.Pdf417Parameters.setPdf417ErrorLevel (   self,
  value 
)

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.

◆ setPdf417MacroAddressee()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroAddressee (   self,
  value 
)

Sets macro Pdf417 barcode addressee name.

◆ setPdf417MacroChecksum()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroChecksum (   self,
  value 
)

Sets macro Pdf417 barcode checksum.

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

◆ setPdf417MacroECIEncoding()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroECIEncoding (   self,
  value 
)

Extended Channel Interpretation Identifiers.

Applies for Macro PDF417 text fields.

◆ setPdf417MacroFileID()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroFileID (   self,
  value 
)

Sets macro Pdf417 barcode's file ID.

Used for MacroPdf417.

◆ setPdf417MacroFileName()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroFileName (   self,
  value 
)

Sets macro Pdf417 barcode file name.

◆ setPdf417MacroFileSize()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroFileSize (   self,
  value 
)

Gets or sets macro Pdf417 file size.

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

◆ setPdf417MacroSegmentID()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroSegmentID (   self,
  value 
)

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

◆ setPdf417MacroSegmentsCount()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroSegmentsCount (   self,
  value 
)

Sets macro Pdf417 barcode segments count.

◆ setPdf417MacroSender()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroSender (   self,
  value 
)

Sets macro Pdf417 barcode sender name.

◆ setPdf417MacroTimeStamp()

def asposebarcode.Generation.Pdf417Parameters.setPdf417MacroTimeStamp (   self,
  value 
)

Sets macro Pdf417 barcode time stamp.

◆ setPdf417Truncate()

def asposebarcode.Generation.Pdf417Parameters.setPdf417Truncate (   self,
  value 
)

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

◆ setReaderInitialization()

def asposebarcode.Generation.Pdf417Parameters.setReaderInitialization (   self,
  value 
)

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

Parameters
value

◆ setRows()

def asposebarcode.Generation.Pdf417Parameters.setRows (   self,
  value 
)

Rows count.

◆ toString()

def asposebarcode.Generation.Pdf417Parameters.toString (   self)

Returns a human-readable string representation of this Pdf417Parameters.

Returns
A string that represents this Pdf417Parameters.