Namespaces | |
ParamsSpecification | |
Classes | |
class | AustralianPostParameters |
AustralianPost barcode parameters. More... | |
class | AztecExtCodetextBuilder |
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 | Code128Parameters |
Code128 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 | DataMatrixExtCodetextBuilder |
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 | HanXinExtCodetextBuilder |
class | HanXinParameters |
Han Xin parameters. More... | |
class | HslaColor |
Class for representing HSLA color (Hue, Saturation, Lightness, Alpha) More... | |
class | ImageParameters |
Image 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, 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. 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 | SvgParameters |
SVG parameters. 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 |
Encoding mode for Aztec barcodes.
Enumerator | |
---|---|
Auto | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
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 AztecExtCodetextBuilder 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. |
Extended | Extended mode which supports multi ECI modes. It is better to use AztecExtCodetextBuilder 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. |
Binary | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
ECI | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |
|
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 |
Encoding mode for Code128 barcodes. Code 128specification.
Thos code demonstrates how to generate code 128 with different encodings
|
strong |
|
strong |
Specify the type of the ECC to encode.
DataMatrix encoder's encoding mode, default to Auto
This sample shows how to do codetext in Extended Mode.
Enumerator | |
---|---|
Auto | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
ASCII | Encodes one alphanumeric or two numeric characters per byte |
Bytes | Encode 8 bit values
|
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 and ECI encodings in codetext. It is better to use DataMatrixExtCodetextBuilder 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. Encodation schemes are set in the next format : "\Encodation_scheme_name:text\Encodation_scheme_name:text". Allowed encodation schemes are: EDIFACT, ANSIX12, ASCII, C40, Text, Auto. All backslashes () must be doubled in text. |
Extended | ExtendedCodetext mode allows to manually switch encodation schemes and ECI encodings in codetext. It is better to use DataMatrixExtCodetextBuilder 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. Encodation schemes are set in the next format : "\Encodation_scheme_name:text\Encodation_scheme_name:text". Allowed encodation schemes are: EDIFACT, ANSIX12, ASCII, C40, Text, Auto. All backslashes () must be doubled in text. |
Base256 | Encode 8 bit values |
Binary | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
ECI | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |
|
strong |
Specify the type of the ECC to encode.
|
strong |
Encoding mode for DotCode barcodes.
Enumerator | |
---|---|
Auto | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
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. |
Binary | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
ECI | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |
Extended | 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.
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 |
Han Xin Code encoding mode. It is recommended to use Auto with ASCII / Chinese characters or Unicode for Unicode characters.
Enumerator | |
---|---|
Auto | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are encoded using GB18030 encoding according to HanXin barcode specification. |
Binary | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
ECI | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |
Unicode | Unicode mode designs a way to represent any text data reference to UTF8 encoding/charset in Han Xin Code. |
URI | URI mode indicates the data represented in Han Xin Code is Uniform Resource Identifier (URI) reference to RFC 3986. |
Extended | Extended mode allow combinations of internal modes: Auto, Binary, Text, Numeric, URI, Unicode, ECI, Common Chinese Region One, Common Chinese Region Two, GB18030 Two Byte, GB18030 Four Byte. Codetext can be built manually with prefixes and doubled backslashes, e.g.: ":abc\000009:ΑΒΓΔΕ:ab\c" or using the HanXinExtCodetextBuilder. If the codetext contains an ECI fragment, then only the following modes can be in that codetext after ECI fragment: Auto, Binary, Text, Numeric, URI, ECI. |
|
strong |
|
strong |
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.
|
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.
hese samples show how to encode Macro Characters in MicroPdf417 and DataMatrix
|
strong |
Encoding mode for MaxiCode barcodes.
Enumerator | |
---|---|
Auto | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
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. |
Extended | 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. |
Binary | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
ECI | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |
|
strong |
Encoding mode for MaxiCode barcodes.
This sample shows how to genereate MaxiCode barcodes using ComplexBarcodeGenerator
|
strong |
Version of MicroQR Code. From M1 to M4.
|
strong |
PatchCode format. Choose PatchOnly to generate single PatchCode. Use page format to generate Patch page with PatchCodes as borders
Pdf417 barcode compaction mode
Enumerator | |
---|---|
Auto | auto detect compaction mode
|
Text | text compaction
|
Numeric | numeric compaction mode
|
Binary | binary compaction mode
|
|
strong |
Pdf417 barcode encode mode
|
strong |
pdf417 barcode's error correction level, from level 0 to level 9, level 0 means no error correction, level 8 means best error correction
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.
These samples show how to encode and save QR barcode with extended data formats.
Enumerator | |
---|---|
Auto | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are encoded in kanji mode if possible, or they are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
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 mode is not supported by MicroQR barcodes.
|
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 mode is not supported by MicroQR barcodes. |
Extended | 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 mode is not supported by MicroQR barcodes. |
Binary | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
ECI | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. This mode is not supported by MicroQR barcodes. |
|
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 |
Level of Reed-Solomon error correction. From low to high: LevelL, LevelM, LevelQ, LevelH.
|
strong |
Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr.
Enumerator | |
---|---|
Auto | Specifies to automatically pick up the best version for QR. This is default value. |
Version01 | Specifies version 1 with 21 x 21 modules. |
Version02 | Specifies version 2 with 25 x 25 modules. |
Version03 | Specifies version 3 with 29 x 29 modules. |
Version04 | Specifies version 4 with 33 x 33 modules. |
Version05 | Specifies version 5 with 37 x 37 modules. |
Version06 | Specifies version 6 with 41 x 41 modules. |
Version07 | Specifies version 7 with 45 x 45 modules. |
Version08 | Specifies version 8 with 49 x 49 modules. |
Version09 | Specifies version 9 with 53 x 53 modules. |
Version10 | Specifies version 10 with 57 x 57 modules. |
Version11 | Specifies version 11 with 61 x 61 modules. |
Version12 | Specifies version 12 with 65 x 65 modules. |
Version13 | Specifies version 13 with 69 x 69 modules. |
Version14 | Specifies version 14 with 73 x 73 modules. |
Version15 | Specifies version 15 with 77 x 77 modules. |
Version16 | Specifies version 16 with 81 x 81 modules. |
Version17 | Specifies version 17 with 85 x 85 modules. |
Version18 | Specifies version 18 with 89 x 89 modules. |
Version19 | Specifies version 19 with 93 x 93 modules. |
Version20 | Specifies version 20 with 97 x 97 modules. |
Version21 | Specifies version 21 with 101 x 101 modules. |
Version22 | Specifies version 22 with 105 x 105 modules. |
Version23 | Specifies version 23 with 109 x 109 modules. |
Version24 | Specifies version 24 with 113 x 113 modules. |
Version25 | Specifies version 25 with 117 x 117 modules. |
Version26 | Specifies version 26 with 121 x 121 modules. |
Version27 | Specifies version 27 with 125 x 125 modules. |
Version28 | Specifies version 28 with 129 x 129 modules. |
Version29 | Specifies version 29 with 133 x 133 modules. |
Version30 | Specifies version 30 with 137 x 137 modules. |
Version31 | Specifies version 31 with 141 x 141 modules. |
Version32 | Specifies version 32 with 145 x 145 modules. |
Version33 | Specifies version 33 with 149 x 149 modules. |
Version34 | Specifies version 34 with 153 x 153 modules. |
Version35 | Specifies version 35 with 157 x 157 modules. |
Version36 | Specifies version 36 with 161 x 161 modules. |
Version37 | Specifies version 37 with 165 x 165 modules. |
Version38 | Specifies version 38 with 169 x 169 modules. |
Version39 | Specifies version 39 with 173 x 173 modules. |
Version40 | Specifies version 40 with 177 x 177 modules. |
VersionM1 | Specifies version M1 for Micro QR with 11 x 11 modules.
|
VersionM2 | Specifies version M2 for Micro QR with 13 x 13 modules.
|
VersionM3 | Specifies version M3 for Micro QR with 15 x 15 modules.
|
VersionM4 | Specifies version M4 for Micro QR with 17 x 17 modules.
|
|
strong |
Version of RectMicroQR Code. From version R7x43 to version R17x139.
|
strong |
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
|
strong |
|
strong |
Type of 2D component
This sample shows how to create and save a GS1 Composite Bar image. Note that 1D codetext and 2D codetext are separated by symbol '/'