Namespaces | |
ParamsSpecification | |
Classes | |
class | AustralianPostParameters |
AustralianPost barcode parameters. More... | |
class | AztecParameters |
Aztec parameters. More... | |
class | BarcodeGenerator |
BarcodeGenerator for backend barcode images generation. More... | |
class | BarcodeParameters |
Barcode generation parameters. More... | |
class | BaseEncodeType |
Base class for SymbologyEncodeType. More... | |
class | BaseGenerationParameters |
Barcode image generation parameters. More... | |
class | BorderParameters |
Barcode image border parameters More... | |
class | CaptionParameters |
Caption parameters. More... | |
class | CodabarParameters |
Codabar parameters. More... | |
class | CodablockParameters |
Codablock parameters. More... | |
class | Code16KParameters |
Code16K parameters. More... | |
class | CodetextParameters |
Codetext parameters. More... | |
class | CouponParameters |
Coupon parameters. Used for UpcaGs1DatabarCoupon, UpcaGs1Code128Coupon. More... | |
class | DataBarParameters |
Databar parameters. More... | |
class | DataMatrixParameters |
DataMatrix parameters. More... | |
class | DotCodeExtCodetextBuilder |
class | DotCodeParameters |
DotCode parameters. More... | |
class | EncodeTypes |
Specifies the type of barcode to encode. More... | |
class | ExtCodetextBuilder |
Helper class for automatic codetext generation of the Extended Codetext Mode More... | |
class | FontUnit |
Defines a particular format for text, including font face, size, and style attributes where size in Unit value property. More... | |
class | GS1CompositeBarParameters |
GS1 Composite bar parameters. More... | |
class | ISimplePropertyChangedEventHandler |
class | ITFParameters |
ITF parameters. More... | |
class | MaxiCodeExtCodetextBuilder |
class | MaxiCodeParameters |
MaxiCode parameters. More... | |
class | Padding |
Paddings parameters. More... | |
class | PatchCodeParameters |
PatchCode parameters. More... | |
class | Pdf417Parameters |
PDF417 parameters. Contains PDF417, MacroPDF417 and MicroPDF417 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. More... | |
class | PostalParameters |
Postal parameters. Used for Postnet, Planet. More... | |
class | QrExtCodetextBuilder |
class | QrParameters |
QR parameters. More... | |
class | QrStructuredAppendParameters |
QR structured append parameters. More... | |
class | SupplementParameters |
Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN. More... | |
class | SymbologyEncodeType |
Symbology encode type. See EncodeTypes to get instance. More... | |
class | Unit |
Specifies the size value in different units (Pixel, Inches, etc.). More... | |
|
strong |
Specifies the different types of automatic sizing modes.
|
strong |
Specifies the Aztec symbol mode.
This sample shows how to change Aztec Symbol mode and save a BarCode image.
|
strong |
Specifies the file format of the image.
|
strong |
Specifies the style of dashed border lines.
|
strong |
|
strong |
Specifies the start or stop symbol of the Codabar barcode specification.
|
strong |
Function codewords for Code 128 emulation. Applied for MicroPDF417 only. Ignored for PDF417 and MacroPDF417 barcodes.
|
strong |
|
strong |
Specify the type of the ECC to encode.
DataMatrix encoder's encoding mode, default to Auto
Enumerator | |
---|---|
Auto | Automatically pick up the best encode mode for Datamatrix encoding |
ASCII | Encodes one alphanumeric or two numeric characters per byte |
Full | Encode 8 bit values |
Custom | Encode with the encoding specified in BarcodeGenerator.Parameters.Barcode.DataMatrix.CodeTextEncoding |
C40 | Uses C40 encoding. Encodes Upper-case alphanumeric, Lower case and special characters |
Text | Uses Text encoding. Encodes Lower-case alphanumeric, Upper case and special characters |
EDIFACT | Uses EDIFACT encoding. Uses six bits per character, encodes digits, upper-case letters, and many punctuation marks, but has no support for lower-case letters. |
ANSIX12 | Uses ANSI X12 encoding. |
ExtendedCodetext | ExtendedCodetext mode allows to manually switch encodation schemes in codetext. Format : "\Encodation_scheme_name:text\Encodation_scheme_name:text". Allowed encodation schemes are: EDIFACT, ANSIX12, ASCII, C40, Text, Auto. Extended codetext example: ":ANSIX12TEXT:backslash must be \ doubled:EdifactEncodedText" All backslashes () must be doubled in text. This sample shows how to do codetext in Extended Mode. [C#] using (Aspose.BarCode.Generation.BarcodeGenerator generator = new Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.DataMatrix)) { generator.CodeText = @"\ansix12:ANSIX12TEXT\ascii:backslash must be \\ doubled\edifact:EdifactEncodedText"; generator.Parameters.Barcode.DataMatrix.DataMatrixEncodeMode = DataMatrixEncodeMode.ExtendedCodetext; generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text"; generator.Save("test.png"); } [VB.NET] generator.CodeText = "\\ansix12:ANSIX12TEXT\\ascii:backslash must be \\\\ escaped and doubled\\edifact:EdifactEncodedText" generator.Parameters.Barcode.DataMatrix.DataMatrixEncodeMode = DataMatrixEncodeMode.ExtendedCodetext generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text" generator.Save("test.png") End Using |
|
strong |
Encoding mode for DotCode barcodes.
Enumerator | |
---|---|
Auto | Encode codetext with value set in the ECIEncoding property. |
Bytes | Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
ExtendedCodetext | Extended mode which supports multi ECI modes. It is better to use DotCodeExtCodetextBuilder for extended codetext generation. Use Display2DText property to set visible text to removing managing characters. ECI identifiers are set as single slash and six digits identifier "\000026" - UTF8 ECI identifier All unicode characters after ECI identifier are automatically encoded into correct character codeset. |
|
strong |
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. Currently, it is used only for QR 2D barcode.
This sample shows how to use ECI encoding and save a BarCode image.
|
strong |
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
Enumerator | |
---|---|
Default | If checksum is required by the specification - it will be attached. |
Yes | Always use checksum if possible. |
No | Do not use checksum. |
|
strong |
|
strong |
ITF14 border type of barcode
|
strong |
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.
Enumerator | |
---|---|
None | None of Macro Characters are added to barcode data |
Macro05 | 05 Macro craracter is added to barcode data in first position. GS1 Data Identifier ISO 15434 Character is translated to "[)>\u001E05\u001D" as decoded data header and "\u001E\u0004" as decoded data trailer. This sample shows how to detect Code39 and Code128 barcodes. [C#] //to generate autoidentified GS1 message like this "(10)123ABC(10)123ABC" in ISO 15434 format you need: BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.DataMatrix, "10123ABC\u001D10123ABC"); generator.Parameters.Barcode.DataMatrix.MacroCharacters = MacroCharacter.Macro05; BarCodeReader reader = new BarCodeReader(generator.GenerateBarCodeImage(), DecodeType.GS1DataMatrix); foreach (BarCodeResult result in reader.ReadBarCodes()) Console.WriteLine("BarCode CodeText: " + result.CodeText); |
Macro06 | 06 Macro craracter is added to barcode data in first position. ASC MH10 Data Identifier ISO 15434 Character is translated to "[)>\u001E06\u001D" as decoded data header and "\u001E\u0004" as decoded data trailer. |
|
strong |
Encoding mode for MaxiCode barcodes.
Enumerator | |
---|---|
Auto | Encode codetext with value set in the ECIEncoding property. |
Bytes | Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
ExtendedCodetext | Extended mode which supports multi ECI modes. It is better to use MaxiCodeExtCodetextBuilder for extended codetext generation. Use Display2DText property to set visible text to removing managing characters. ECI identifiers are set as single slash and six digits identifier "\000026" - UTF8 ECI identifier All unicode characters after ECI identifier are automatically encoded into correct character codeset. |
|
strong |
Encoding mode for MaxiCode barcodes.
This sample shows how to genereate MaxiCode barcodes using ComplexBarcodeGenerator
|
strong |
PatchCode format. Choose PatchOnly to generate single PatchCode. Use page format to generate Patch page with PatchCodes as borders
|
strong |
pdf417 barcode's error correction level, from level 0 to level 9, level 0 means no error correction, level 9 means best error correction
Enumerator | |
---|---|
Level0 | level = 0. |
Level1 | level = 1. |
Level2 | level = 2. |
Level3 | level = 3. |
Level4 | level = 4. |
Level5 | level = 5. |
Level6 | level = 6. |
Level7 | level = 7. |
Level8 | level = 8. |
Used to tell the encoder whether to add Macro PDF417 Terminator (codeword 922) to the segment. Applied only for Macro PDF417.
|
strong |
Encoding mode for QR barcodes. It is recommended to Use Auto with CodeTextEncoding = Encoding.UTF8 for Latin symbols or digits and Utf8BOM for Unicode symbols.
Enumerator | |
---|---|
Auto | Encode codetext as is non-Unicode charset. If there is any Unicode character, the codetext will be encoded with value which is set in CodeTextEncoding. |
Bytes | Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
Utf8BOM | Encode codetext with UTF8 encoding with first ByteOfMark character. |
Utf16BEBOM | Encode codetext with UTF8 encoding with first ByteOfMark character. It can be problems with some barcode scanners. |
ECIEncoding | Encode codetext with value set in the ECIEncoding property. It can be problems with some old (pre 2006) barcode scanners. This sample shows how to use ECI encoding and save a BarCode image. [C#] using (Aspose.BarCode.Generation.BarcodeGenerator generator = new Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.QR)) { generator.CodeText = "12345TEXT"; generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ECIEncoding; generator.Parameters.Barcode.QR.QrEncodeType = QREncodeType.ForceQR; generator.Parameters.Barcode.QR.QrECIEncoding = ECIEncodings.UTF8; generator.Save("test.png"); } [VB.NET] generator.CodeText = "12345TEXT" generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ECIEncoding generator.Parameters.Barcode.QR.QrEncodeType = QREncodeType.ForceQR generator.Parameters.Barcode.QR.QrECIEncoding = ECIEncodings.UTF8 generator.Save("test.png") End Using |
ExtendedCodetext | Extended Channel mode which supports FNC1 first position, FNC1 second position and multi ECI modes. It is better to use QrExtCodetextBuilder for extended codetext generation. Use Display2DText property to set visible text to removing managing characters. Encoding Principles: All symbols "\" must be doubled "\\" in the codetext. FNC1 in first position is set in codetext as as "<FNC1>" FNC1 in second position is set in codetext as as "<FNC1(value)>". The value must be single symbols (a-z, A-Z) or digits from 0 to 99. Group Separator for FNC1 modes is set as 0x1D character '\u001D' If you need to insert "<FNC1>" string into barcode write it as "<\FNC1>" ECI identifiers are set as single slash and six digits identifier "\000026" - UTF8 ECI identifier TO disable current ECI mode and convert to default JIS8 mode zero mode ECI indetifier is set. "\000000" All unicode characters after ECI identifier are automatically encoded into correct character codeset. This sample shows how to use FNC1 first position in Extended Mode. [C#] //create codetext QrExtCodetextBuilder textBuilder = new QrExtCodetextBuilder(); textBuilder.AddFNC1FirstPosition(); textBuilder.AddPlainCodetext("000%89%%0"); textBuilder.AddFNC1GroupSeparator(); textBuilder.AddPlainCodetext("12345<FNC1>"); //generate barcode using (Aspose.BarCode.Generation.BarcodeGenerator generator = new Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.QR)) { generator.CodeText = textBuilder.GetExtendedCodetext(); generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ExtendedCodetext; generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text"; generator.Save(@"d:\test.png"); } [VB.NET] 'create codetext Dim textBuilder As New QrExtCodetextBuilder() textBuilder.AddFNC1FirstPosition() textBuilder.AddPlainCodetext("000%89%%0") textBuilder.AddFNC1GroupSeparator() textBuilder.AddPlainCodetext("12345<FNC1>") 'generate barcode generator.CodeText = textBuilder.GetExtendedCodetext() generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ExtendedCodetext generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text" generator.Save("test.png") End Using This sample shows how to use FNC1 second position in Extended Mode. [C#] //create codetext QrExtCodetextBuilder textBuilder = new QrExtCodetextBuilder(); textBuilder.AddFNC1SecondPosition("12"); textBuilder.AddPlainCodetext("TRUE3456"); //generate barcode using (Aspose.BarCode.Generation.BarcodeGenerator generator = new Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.QR)) { generator.CodeText = textBuilder.GetExtendedCodetext(); generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ExtendedCodetext; generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text"; generator.Save(@"d:\test.png"); } [VB.NET] 'create codetext Dim textBuilder As New QrExtCodetextBuilder() textBuilder.AddFNC1SecondPosition("12") textBuilder.AddPlainCodetext("TRUE3456") 'generate barcode generator.CodeText = textBuilder.GetExtendedCodetext() generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ExtendedCodetext generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text" generator.Save("test.png") End Using <br> This sample shows how to use multi ECI mode in Extended Mode. [C#] //create codetext QrExtCodetextBuilder textBuilder = new QrExtCodetextBuilder(); textBuilder.AddECICodetext(ECIEncodings.Win1251, "Will"); textBuilder.AddECICodetext(ECIEncodings.UTF8, "Right"); textBuilder.AddECICodetext(ECIEncodings.UTF16BE, "Power"); textBuilder.AddPlainCodetext(@"t\e\\st"); <br> //generate barcode using (Aspose.BarCode.Generation.BarcodeGenerator generator = new Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.QR)) { generator.CodeText = textBuilder.GetExtendedCodetext(); generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ExtendedCodetext; generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text"; generator.Save(@"d:\test.png"); } [VB.NET] 'create codetext Dim textBuilder As New QrExtCodetextBuilder() textBuilder.AddECICodetext(ECIEncodings.Win1251, "Will") textBuilder.AddECICodetext(ECIEncodings.UTF8, "Right") textBuilder.AddECICodetext(ECIEncodings.UTF16BE, "Power") textBuilder.AddPlainCodetext(@"t\e\\st") 'generate barcode generator.CodeText = textBuilder.GetExtendedCodetext() generator.Parameters.Barcode.QR.QrEncodeMode = QREncodeMode.ExtendedCodetext generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text" generator.Save("test.png") End Using <br> |
|
strong |
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.
|
strong |
|
strong |
Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr.
|
strong |
|
strong |