Documentation – API Reference

Python-Net: aspose.barcode

Mon, 01 Jan 0001 00:00:00 +0000

The Aspose.BarCode contains tools for the 1D/2D barcodes generation and drawing.

Classes

Class	Description
BuildVersionInfo	Contains the current build version information.
License	Provides methods to license the component.
Metered	Provides methods to set metered key.
XmlSerializationAttribute	Represents attribute for xml entity generator.

Enumerations

Enumeration	Description
CustomerInformationInterpretingType	Defines the interpreting type (CTable, NTable or Other) of customer information for AustralianPost BarCode.
XmlSerializationType	Represents type of xml serialization.

Python-Net: aspose.barcode.barcoderecognition

Mon, 01 Jan 0001 00:00:00 +0000

The Aspose.BarCode.BarCodeRecognition contains tools for the 1D/2D barcodes recognition.

Classes

Class	Description
AustraliaPostCustomerInformationDecoder	Public interface for Customer Information Field decoding which is used in AustraliaPost symbology. Implementation should be provided by user.
AustraliaPostSettings	AustraliaPost decoding parameters. Contains parameters which make influence on recognized data of AustraliaPost symbology.
AztecExtendedParameters	Stores special data of Aztec recognized barcode
BarCodeExtendedParameters	Stores extended parameters of recognized barcode
BarCodeReader	BarCodeReader encapsulates an image which may contain one or several barcodes, it then can perform ReadBarCodes operation to detect barcodes.
BarCodeRegionParameters	Represents the recognized barcode’s region and barcode angle
BarCodeResult	Stores recognized barcode data like SingleDecodeType type, string codetext, BarCodeRegionParameters region and other parameters
BarcodeSettings	The main BarCode decoding parameters. Contains parameters which make influence on recognized data.
BaseDecodeType	Base class for MultyDecodeType and SingleDecodeType.
BaseExtendedParameters	Basic class for extended parameters of recognized barcode storing
CodabarExtendedParameters	Stores a Codabar additional information of recognized barcode
Code128DataPortion	Contains the data of subtype for Code128 type barcode
Code128ExtendedParameters	Stores special data of Code128 recognized barcode
DataBarExtendedParameters	Stores a DataBar additional information of recognized barcode
DataMatrixExtendedParameters	Stores special data of DataMatrix recognized barcode
DecodeType	Specify the type of barcode to read.
DotCodeExtendedParameters	Stores special data of DotCode recognized barcode
GS1CompositeBarExtendedParameters	Stores special data of GS1 Composite Bar recognized barcode
MaxiCodeExtendedParameters	Stores a MaxiCode additional information of recognized barcode
MultyDecodeType	Composite decode type.
OneDExtendedParameters	Stores special data of 1D recognized barcode like separate codetext and checksum
Pdf417ExtendedParameters	Stores a MacroPdf417 metadata information of recognized barcode
QRExtendedParameters	Stores a QR Structured Append information of recognized barcode
Quadrangle	Stores a set of four s that represent a Quadrangle region.
QualitySettings	QualitySettings allows to configure recognition quality and speed manually. You can quickly set up QualitySettings with embedded presets: HighPerformance, NormalQuality, HighQuality, MaxQuality or you can manually configure separate options. Default value of QualitySettings is NormalQuality.
SingleDecodeType	Single decode type. See decode type to get instance.

Enumerations

Enumeration	Description
BarCodeConfidence	Contains recognition confidence level
BarcodeQualityMode	Mode which enables methods to recognize barcode elements with the selected quality. Barcode element with lower quality requires more hard methods which slows the recognition.
ChecksumValidation	Enable checksum validation during recognition for 1D and Postal barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar, PatchCode, Pharmacode, DataLogic2of5 Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, ItalianPost25, Matrix2of5, MSI, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies
Code128SubType	Contains types of Code128 subset
ComplexBackgroundMode	Mode which enables or disables additional recognition of color barcodes on color images.
DeconvolutionMode	Deconvolution (image restorations) mode which defines level of image degradation. Originally deconvolution is a function which can restore image degraded (convoluted) by any natural function like blur, during obtaining image by camera. Because we cannot detect image function which corrupt the image, we have to check most well know functions like sharp or mathematical morphology.
InverseImageMode	Mode which enables or disables additional recognition of barcodes on images with inverted colors (luminance).
XDimensionMode	Recognition mode which sets size (from 1 to infinity) of barcode minimal element: matrix cell or bar.

Python-Net: aspose.barcode.common

Mon, 01 Jan 0001 00:00:00 +0000

The BarCode.Common contains common features and helper tools to maintain the main functionality.

Classes

Class	Description
ProcessorSettings	ProcessorSettings allow to recognize barcodes with multi-threaded increasing of performance

Python-Net: aspose.barcode.complexbarcode

Mon, 01 Jan 0001 00:00:00 +0000

The Aspose.BarCode.ComplexBarcode containing general classes for the implementation of complex BarCode generation functions.

Classes

Class	Description
Address	Address of creditor or debtor. You can either set street, house number, postal code and town (type
AlternativeScheme	Alternative payment scheme instructions
ComplexBarcodeGenerator	ComplexBarcodeGenerator for backend complex barcode (e.g. SwissQR) images generation.
ComplexCodetextReader	ComplexCodetextReader decodes codetext to specified complex barcode type.
HIBCLICCombinedCodetext	Class for encoding and decoding the text embedded in the HIBC LIC code which stores primary and secodary data.
HIBCLICComplexCodetext	Base class for encoding and decoding the text embedded in the HIBC LIC code.
HIBCLICPrimaryDataCodetext	Class for encoding and decoding the text embedded in the HIBC LIC code which stores primary data.
HIBCLICSecondaryAndAdditionalDataCodetext	Class for encoding and decoding the text embedded in the HIBC LIC code which stores seconday data.
HIBCPASCodetext	Class for encoding and decoding the text embedded in the HIBC PAS code.
HIBCPASRecord	Class for storing HIBC PAS record.
IComplexCodetext	Interface for complex codetext used with ComplexBarcodeGenerator.
Mailmark2DCodetext	Class for encoding and decoding the text embedded in the Royal Mail 2D Mailmark code.
MailmarkCodetext	Class for encoding and decoding the text embedded in the 4-state Royal Mailmark code.
MaxiCodeCodetext	Base class for encoding and decoding the text embedded in the MaxiCode code.
MaxiCodeCodetextMode2	Class for encoding and decoding the text embedded in the MaxiCode code for modes 2.
MaxiCodeCodetextMode3	Class for encoding and decoding the text embedded in the MaxiCode code for modes 3.
MaxiCodeSecondMessage	Base class for encoding and decoding second message for MaxiCode barcode.
MaxiCodeStandardCodetext	Class for encoding and decoding MaxiCode codetext for modes 4, 5 and 6.
MaxiCodeStandartSecondMessage	Class for encoding and decoding standart second message for MaxiCode barcode.
MaxiCodeStructuredCodetext	Base class for encoding and decoding the text embedded in the MaxiCode code for modes 2 and 3.
MaxiCodeStructuredSecondMessage	Class for encoding and decoding structured second message for MaxiCode barcode.
PrimaryData	Class for storing HIBC LIC primary data.
SecondaryAndAdditionalData	Class for storing HIBC LIC secondary and additional data.
SwissQRBill	SwissQR bill data
SwissQRCodetext	Class for encoding and decoding the text embedded in the SwissQR code.

Enumerations

Enumeration	Description
AddressType	Address type
HIBCLICDateFormat	Specifies the different types of date formats for HIBC LIC.
HIBCPASDataLocation	HIBC PAS data location types.
HIBCPASDataType	HIBC PAS record’s data types.
Mailmark2DType	2D Mailmark Type defines size of Data Matrix barcode

Python-Net: aspose.barcode.generation

Mon, 01 Jan 0001 00:00:00 +0000

The Aspose.BarCode.Generation containing general classes for the implementation of BarCode generation functions.

Classes

Class	Description
AustralianPostParameters	AustralianPost barcode parameters.
AztecExtCodetextBuilder	Extended codetext generator for Aztec barcodes for ExtendedCodetext Mode of AztecEncodeMode Use TwoDDisplayText property of BarcodeGenerator to set visible text to removing managing characters.
AztecParameters	Aztec parameters.
BarcodeGenerator	BarcodeGenerator for backend barcode images generation. supported symbologies: 1D: Codabar, Code11, Code128, Code39, Code39FullASCII Code93, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, ISBN, GS1Code128, Postnet, Planet EAN14, SCC14, SSCC18, ITF14, SingaporePost … 2D: Aztec, DataMatrix, PDf417, QR code …
BarcodeParameters	Barcode generation parameters.
BaseEncodeType	Base class for SymbologyEncodeType.
BaseGenerationParameters	Barcode image generation parameters.
BorderParameters	Barcode image border parameters
CMYKColor	Class for CMYK color. Null means CMYK is not used, default RGB color is in use.
CaptionParameters	Caption parameters.
CodabarParameters	Codabar parameters.
CodablockParameters	Codablock parameters.
Code128Parameters	Code128 parameters.
Code16KParameters	Code16K parameters.
CodetextParameters	Codetext parameters.
CouponParameters	Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon.
DataBarParameters	Databar parameters.
DataMatrixExtCodetextBuilder	Extended codetext generator for 2D DataMatrix barcodes for ExtendedCodetext Mode of DataMatrixEncodeMode
DataMatrixParameters	DataMatrix parameters.
DotCodeExtCodetextBuilder	Extended codetext generator for 2D DotCode barcodes for ExtendedCodetext Mode of DotCodeEncodeMode
DotCodeParameters	DotCode parameters.
EncodeTypes	Specifies the type of barcode to encode.
ExtCodetextBuilder	Helper class for automatic codetext generation of the Extended Codetext Mode
FontUnit	Defines a particular format for text, including font face, size, and style attributes where size in Unit value property.
GS1CompositeBarParameters	GS1 Composite bar parameters.
HanXinExtCodetextBuilder	Extended codetext generator for Han Xin Code for Extended Mode of HanXinEncodeMode
HanXinParameters	Han Xin parameters.
HslaColor	Class for representing HSLA color (Hue, Saturation, Lightness, Alpha)
ITFParameters	ITF parameters.
ImageParameters	Image parameters.
MaxiCodeExtCodetextBuilder	Extended codetext generator for MaxiCode barcodes for ExtendedCodetext Mode of MaxiCodeEncodeMode Use TwoDDisplayText property of BarcodeGenerator to set visible text to removing managing characters.
MaxiCodeParameters	MaxiCode parameters.
Padding	Paddings parameters.
PatchCodeParameters	PatchCode parameters.
Pdf417Parameters	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.
PdfParameters	PDF parameters.
PostalParameters	Postal parameters. Used for Postnet, Planet.
QrExtCodetextBuilder	Extended codetext generator for 2D QR barcodes for ExtendedCodetext Mode of QrEncodeMode Use TwoDDisplayText property of BarcodeGenerator to set visible text to removing managing characters.
QrParameters	QR parameters.
QrStructuredAppendParameters	QR structured append parameters.
SupplementParameters	Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN.
SvgParameters	SVG parameters.
SymbologyEncodeType	Symbology encode type. See EncodeTypes to get instance.
Unit	Specifies the size value in different units (Pixel, Inches, etc.).

Enumerations

Enumeration	Description
AutoSizeMode	Specifies the different types of automatic sizing modes.
AztecEncodeMode	Encoding mode for Aztec barcodes.
AztecSymbolMode	Specifies the Aztec symbol mode.
BarCodeImageFormat	Specifies the file format of the image.
BarcodeClassifications	Symbology classification
BorderDashStyle	Specifies the style of dashed border lines.
CodabarChecksumMode	Specifies the checksum algorithm for Codabar
CodabarSymbol	Specifies the start or stop symbol of the Codabar barcode specification.
Code128EncodeMode	Encoding mode for Code128 barcodes.
CodeLocation	Codetext location
DataMatrixEccType	Specify the type of the ECC to encode.
DataMatrixEncodeMode	DataMatrix encoder’s encoding mode, default to Auto
DataMatrixVersion	Specify the type of the ECC to encode.
DotCodeEncodeMode	Encoding mode for DotCode barcodes.
ECIEncodings	Extended Channel Interpretation Identifiers. It is used to tell the barcode reader details about the used references for encoding the data in the symbol.
EnableChecksum	Enable checksum during generation for 1D barcodes. Default is treated as Yes for symbologies which must contain checksum, as No where checksum only possible. Checksum never used: Codabar Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN Checksum always used: Rest symbologies
FontMode	Font size mode.
HanXinEncodeMode	Han Xin Code encoding mode. It is recommended to use Auto with ASCII / Chinese characters or Unicode for Unicode characters.
HanXinErrorLevel	Level of Reed-Solomon error correction. From low to high: L1, L2, L3, L4.
HanXinVersion	Version of Han Xin Code. From Version01 - 23 x 23 modules to Version84 - 189 x 189 modules, increasing in steps of 2 modules per side.
ITF14BorderType	ITF14 border type of barcode
MacroCharacter	Macro Characters 05 and 06 values are used to obtain more compact encoding in special modes. 05 Macro craracter is translated to “[)>\u001E05\u001D” as decoded data header and “\u001E\u0004” as decoded data trailer. 06 Macro craracter is translated to “[)>\u001E06\u001D” as decoded data header and “\u001E\u0004” as decoded data trailer.
MaxiCodeEncodeMode	Encoding mode for MaxiCode barcodes.
MaxiCodeMode	Encoding mode for MaxiCode barcodes.
MicroQRVersion	Version of MicroQR Code. From M1 to M4.
PatchFormat	PatchCode format. Choose PatchOnly to generate single PatchCode. Use page format to generate Patch page with PatchCodes as borders
Pdf417CompactionMode	Pdf417 barcode compaction mode
Pdf417EncodeMode	Pdf417 barcode encode mode
Pdf417ErrorLevel	pdf417 barcode’s error correction level, from level 0 to level 9, level 0 means no error correction, level 8 means best error correction
Pdf417MacroTerminator	Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
QREncodeMode	Encoding mode for QR barcodes.
QREncodeType	QR / MicroQR selector mode. Select ForceQR for standard QR symbols, Auto for MicroQR. ForceMicroQR is used for strongly MicroQR symbol generation if it is possible.
QRErrorLevel	Level of Reed-Solomon error correction. From low to high: LevelL, LevelM, LevelQ, LevelH.
QRVersion	Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr.
RectMicroQRVersion	Version of RectMicroQR Code. From version R7x43 to version R17x139.
SvgColorMode	Possible modes for filling color in svg file, RGB is default and supported by SVG 1.1. RGBA, HSL, HSLA is allowed in SVG 2.0 standard. Even in RGB opacity will be set through “fill-opacity” parameter
TextAlignment	Text alignment.
TwoDComponentType	Type of 2D component