SymbologyOptions Class
Free Trial Web API version Licensing Request A Quote
HAVE QUESTIONS OR NEED HELP?SUBMIT THE SUPPORT REQUEST FORM or write email toSUPPORT@BYTESCOUT.COM
Describes symbology specific options.
Inheritance Hierarchy
Bytescout.BarCodeSymbologyOptions
Namespace:Bytescout.BarCode
Assembly: Bytescout.BarCode (in Bytescout.BarCode.dll) Version: 7.6.3.1256-master
Syntax
[TypeConverterAttribute(typeof(ExpandableObjectConverter))] public class SymbologyOptions : ICloneable
The SymbologyOptions type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | SymbologyOptions | Initializes a new instance of the SymbologyOptions class |
Properties
| Name | Description | |
|---|---|---|
 | AztecCompactionMode | Gets or sets the compaction mode to use while creating Aztec barcodes. |
| AztecErrorCorrectionLevel | Gets or sets the error correction level for Aztec Code barcodes. |
| AztecSymbolSize | Gets or sets the minimum size for Aztec Code barcodes. |
| CodabarChecksumAlgorithm | Gets or sets the algorithm to use for Codabar symbology checksum calculation. |
| CodabarStartSymbol | Gets or sets the symbol to use as start symbol in Codabar symbology. |
| CodabarStopSymbol | Gets or sets the symbol to use as stop symbol in Codabar symbology. |
| Code128Alphabet | Gets or sets the alphabet to use for Code 128 symbology. |
| DataMatrixAlternativeReedSolomonCorrectionFor144x144Size | Alternative Reed-Solomon error correction for DataMatrix barcodes of 144x144 size, might be required for compatibility with some hardware barcode scanners. |
| DataMatrixCompactionMode | Gets or sets the compaction mode to use while creating Data Matrix barcodes. |
| DataMatrixSize | Gets or sets the symbol size for Data Matrix barcodes. |
| DrawIntercharacterGap | Gets or sets a value indicating whether to draw intercharacter gaps. |
| EANDrawQuietZoneIndicator | Gets or sets whether to draw the quite zone indicator on EAN-2 and EAN-5 supplementary barcodes. Default is false. |
| Encoding | Gets or sets the character encoding of barcode value for 2D barcode types (QR Code, PDF417, DataMatrix, Aztec, MaxiCode). Default is Default (ANSI). |
| GS1ExpandedStackedSegmentsNumber | Gets or sets the number of segments in line for GS1 DataBar Expanded Stacked symbology. |
| ISBNAutoCaption | Gets or sets a value indicating whether to draw auto created additional caption when encoding barcodes using ISBN symbology.. |
| ISBNCaptionTemplate | Gets or sets the ISBN caption template (e.g. #-#######-#-#). |
| MaxiCodeEnableCustomWidth | Gets or sets a value indicating whether MaxiCode enables the use of a custom width. By default value is true and MaxiCode symbology size is determined as 30*NarrowBarWidth. Set value to false if you want to use standard MaxiCode symbology size (calculated as approximately one inch (2.54 cm) for the current resolution) |
| MaxiCodeMode | Gets or sets the MaxiCode mode. |
| MSIChecksumAlgorithm | Gets or sets the algorithm to use for MSI symbology checksum calculation. |
| OnlyHorizontalBearerBar | Gets or sets a value indicating whether ITF-14 symbology has only horizontal bearer bar or surrounding bars. |
| PDF417ColumnCount | This property is used only when PDF417UseManualSize == true. Gets or sets the exact data column count for PDF417 barcodes. |
| PDF417CompactionMode | Gets or sets the compaction mode to use while creating barcodes of PDF417 family. |
| PDF417CreateMacro | Gets or sets a value indicating whether to create PDF417 barcode as part of Macro PDF417 sequence. |
| PDF417ErrorCorrectionLevel | Gets or sets the error correction level for PDF417 barcodes. |
| PDF417FileID | Gets or sets File ID value for Macro PDF417 barcodes. |
| PDF417LastSegment | Gets or sets a value indicating if current Macro PDF 417 barcode should be marked as last segment of sequence. |
| PDF417MinimumColumnCount | Gets or sets the minimum data column count for PDF417 barcodes. |
| PDF417RowCount | This property is used only when PDF417UseManualSize == true. Gets or sets the exact data row count for PDF417 barcodes. Set this property to zero to automatically calculate it according to the given column count. |
| PDF417SegmentIndex | Gets or sets Segment Index value for current Macro PDF417 barcode. |
| PDF417UseManualSize | Gets a value indicating whether PDF417 barcodes should use exact row and column count (PDF417ColumnCount and PDF417RowCount) instead of minimal column count PDF417MinimumColumnCount. |
| PharmaCodeMiniature | Miniature variant of PharmaCode |
| PharmaCodeSupplementaryBarColor | Color of Supplementary bar in PharmaCode |
| PharmaCodeSupplementaryCode | Add colored Supplementary bar in PharmaCode |
| PharmaCodeTwoTrack | Two-track variant of PharmaCode |
| PZNType | Gets or sets the type of PZN symbology. |
| QREncodeHint | Gets or sets the hint to use when encoding non-alphanumeric data while creating QR Code barcodes. |
| QRErrorCorrectionLevel | Gets or sets the error correction level for QR Code barcodes. |
| QRVersion | Gets or sets the minimum version (size) for QR Code barcodes. |
| ShowStartStop | Gets or sets a value indicating whether to show start and stop symbology symbols in caption text. |
| SupplementSpace | Gets or sets the space (in pixels) between main and supplemental barcode. |
| TelepenAlphabet | Gets or sets the alphabet to use for Telepen symbology. |
| TextEncodingCodePage | Gets or sets the character encoding of barcode value. Default is Default - the default encoding on your computer. You may override this value like: barcode.Options.TextEncodingCodePage = 1250; // to use German locale to decode text Name CodePage EncodingName shift_jis 932 Japanese (Shift-JIS) windows-1250 1250 Central European (Windows) windows-1251 1251 Cyrillic (Windows) Windows-1252 1252 Western European (Windows) windows-1253 1253 Greek (Windows) windows-1254 1254 Turkish (Windows) csISO2022JP 50221 Japanese (JIS-Allow 1 byte Kana) iso-2022-kr 50225 Korean (ISO) |
| TextEncodingUseUTF8 | ActiveX interface: Enables UTF8 text encoding for use for barcode value decoding .NET interface: Use .TextEncoding property and set it to System.Text.Encoding.UTF8 if you need to |
Methods
| Name | Description | |
|---|---|---|
| Clone | Creates a new object that is a copy of the current instance. |
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| FireChanged | Raises the [E:Changed] event. |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when options get changed. |
See Also