Symbology Settings

Defined in namespace Scandit.DataCapture.Barcode.Capture

class SymbologySettings

Added in version 6.2.0

Settings specific to a particular barcode symbology.

Learn more on how to use symbology settings in our Configure Which Barcodes Are Read guide.

Symbology Symbology { get; }

Added in version 6.2.0

The symbology that this symbology settings affect.

bool Enabled { get;set; }

Added in version 6.2.0

By default decoding of all symbologies is disabled. To enable decoding of a symbology, set this property to true. It is advised to only enable symbologies that are required by the application as every enabled symbology adds processing overhead.

This property only enables decoding of dark codes on bright background. If color-inverted (bright on dark) codes for this symbology are required, enable them by changing the ColorInvertedEnabled property.

bool ColorInvertedEnabled { get;set; }

Added in version 6.2.0

Determines whether decoding of color-inverted (bright on dark) codes for this symbology is enabled. By default, decoding of color inverted codes is disabled. Currently, the Enabled property will also have to be set to true for bright on dark codes to be scanned, though this may change in a future release.

Checksum Checksums { get;set; }

Added in version 6.2.0

Set of optional checksums to be used for this symbology. The code is accepted if any of the checksums matches in addition to any mandatory checksum of the symbology.

ICollection<string> EnabledExtensions { get; }

Added in version 6.2.0

The set of enabled extensions of this symbology. Extensions allow to configure features that are specific to a small number of symbologies. For example, there is an extension to configure how to treat the leading zero for UPC-A codes. For a list of supported extensions, refer to Symbology Properties.

ICollection<short> ActiveSymbolCounts { get;set; }

Added in version 6.2.0

This property determines the active symbol counts of the symbology, e.g. the supported length of barcodes to be decoded. Change this property to include symbol counts that are not enabled by default, or to optimize decoding performance for a certain number of symbols.

The mapping from characters to symbols is symbology-specific. For some symbologies, the start and end characters are included, others include checksums characters in the symbol counts.

The active symbol count setting is ignored for fixed-size barcodes (the EAN and UPC family of codes) as well as 2d codes. For other symbologies, refer to Symbology Properties.

When changing the active symbol count, the provided active symbol count values are intersected with the supported active symbol count values of the symbology. Values that are not part of the supported symbol count range are ignored.

void SetExtensionEnabled(string extension, bool enabled)

Added in version 6.2.0

Activates/Deactivates a custom extension for the symbology.

bool IsExtensionEnabled(string extension)

Added in version 6.2.0

Checks if the extension is enabled.

string ToJson()

Added in version 6.2.0