Link Search Menu Expand Document

SymbologyOptions Class

Describes symbology specific options.
Inheritance Hierarchy
SystemObject
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
NameDescription
Public methodSymbologyOptions
Initializes a new instance of the SymbologyOptions class
Top
Properties
NameDescription
Public propertyAztecCompactionMode
Gets or sets the compaction mode to use while creating Aztec barcodes.
Public propertyAztecErrorCorrectionLevel
Gets or sets the error correction level for Aztec Code barcodes.
Public propertyAztecSymbolSize
Gets or sets the minimum size for Aztec Code barcodes.
Public propertyCodabarChecksumAlgorithm
Gets or sets the algorithm to use for Codabar symbology checksum calculation.
Public propertyCodabarStartSymbol
Gets or sets the symbol to use as start symbol in Codabar symbology.
Public propertyCodabarStopSymbol
Gets or sets the symbol to use as stop symbol in Codabar symbology.
Public propertyCode128Alphabet
Gets or sets the alphabet to use for Code 128 symbology.
Public propertyDataMatrixAlternativeReedSolomonCorrectionFor144x144Size
Alternative Reed-Solomon error correction for DataMatrix barcodes of 144x144 size, might be required for compatibility with some hardware barcode scanners.
Public propertyDataMatrixCompactionMode
Gets or sets the compaction mode to use while creating Data Matrix barcodes.
Public propertyDataMatrixSize
Gets or sets the symbol size for Data Matrix barcodes.
Public propertyDrawIntercharacterGap
Gets or sets a value indicating whether to draw intercharacter gaps.
Public propertyEANDrawQuietZoneIndicator
Gets or sets whether to draw the quite zone indicator on EAN-2 and EAN-5 supplementary barcodes. Default is false.
Public propertyEncoding
Gets or sets the character encoding of barcode value for 2D barcode types (QR Code, PDF417, DataMatrix, Aztec, MaxiCode). Default is Default (ANSI).
Public propertyGS1ExpandedStackedSegmentsNumber
Gets or sets the number of segments in line for GS1 DataBar Expanded Stacked symbology.
Public propertyISBNAutoCaption
Gets or sets a value indicating whether to draw auto created additional caption when encoding barcodes using ISBN symbology..
Public propertyISBNCaptionTemplate
Gets or sets the ISBN caption template (e.g. #-#######-#-#).
Public propertyMaxiCodeEnableCustomWidth
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)
Public propertyMaxiCodeMode
Gets or sets the MaxiCode mode.
Public propertyMSIChecksumAlgorithm
Gets or sets the algorithm to use for MSI symbology checksum calculation.
Public propertyOnlyHorizontalBearerBar
Gets or sets a value indicating whether ITF-14 symbology has only horizontal bearer bar or surrounding bars.
Public propertyPDF417ColumnCount
This property is used only when PDF417UseManualSize == true. Gets or sets the exact data column count for PDF417 barcodes.
Public propertyPDF417CompactionMode
Gets or sets the compaction mode to use while creating barcodes of PDF417 family.
Public propertyPDF417CreateMacro
Gets or sets a value indicating whether to create PDF417 barcode as part of Macro PDF417 sequence.
Public propertyPDF417ErrorCorrectionLevel
Gets or sets the error correction level for PDF417 barcodes.
Public propertyPDF417FileID
Gets or sets File ID value for Macro PDF417 barcodes.
Public propertyPDF417LastSegment
Gets or sets a value indicating if current Macro PDF 417 barcode should be marked as last segment of sequence.
Public propertyPDF417MinimumColumnCount
Gets or sets the minimum data column count for PDF417 barcodes.
Public propertyPDF417RowCount
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.
Public propertyPDF417SegmentIndex
Gets or sets Segment Index value for current Macro PDF417 barcode.
Public propertyPDF417UseManualSize
Gets a value indicating whether PDF417 barcodes should use exact row and column count (PDF417ColumnCount and PDF417RowCount) instead of minimal column count PDF417MinimumColumnCount.
Public propertyPharmaCodeMiniature
Miniature variant of PharmaCode
Public propertyPharmaCodeSupplementaryBarColor
Color of Supplementary bar in PharmaCode
Public propertyPharmaCodeSupplementaryCode
Add colored Supplementary bar in PharmaCode
Public propertyPharmaCodeTwoTrack
Two-track variant of PharmaCode
Public propertyPZNType
Gets or sets the type of PZN symbology.
Public propertyQREncodeHint
Gets or sets the hint to use when encoding non-alphanumeric data while creating QR Code barcodes.
Public propertyQRErrorCorrectionLevel
Gets or sets the error correction level for QR Code barcodes.
Public propertyQRVersion
Gets or sets the minimum version (size) for QR Code barcodes.
Public propertyShowStartStop
Gets or sets a value indicating whether to show start and stop symbology symbols in caption text.
Public propertySupplementSpace
Gets or sets the space (in pixels) between main and supplemental barcode.
Public propertyTelepenAlphabet
Gets or sets the alphabet to use for Telepen symbology.
Public propertyTextEncodingCodePage
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
.NET interface: please use Encoding property instead Some of available code pages are listed below for your reference:
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)
Public propertyTextEncodingUseUTF8
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
Top
Methods
NameDescription
Public methodClone
Creates a new object that is a copy of the current instance.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodFireChanged
Raises the [E:Changed] event.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Events
NameDescription
Public eventChanged
Occurs when options get changed.
Top
See Also

Reference