SymbologySettings Class Reference

Public Member Functions

void SetExtensionEnabled (string extension, bool enabled)
bool IsExtensionEnabled (string extension)


bool Enabled [get, set]
bool ColorInvertedEnabled [get, set]
Checksum Checksums [get, set]
IReadOnlyList< UInt16 > ActiveSymbolCounts [get, set]

Detailed Description

Class to hold symbology-specific settings.

In addition to enabling/disabling certain symbologies, the SymbologySettings class holds setttings that are specific to certain symbologies. These settings include optional checksums, and custom extensions that can be enabled for certain symbologies.

Member Function Documentation

void SetExtensionEnabled ( string  extension,
bool  enabled 

Enable/disable a specific symbology extension

extensionThe name of the extension
enabledWhether the extension should be enabled.
bool IsExtensionEnabled ( string  extension)

Determine whether a certain extension is currently enabled.

extensionThe name of the extension.
True if the extension is enabled, false if not.

Property Documentation

bool Enabled

Whether decoding of this symbology is enabled.

bool ColorInvertedEnabled

Whether color-inverted decoding of this symbology is enabled.

Checksum Checksums

Optional checksums enabled for this symbology.

IReadOnlyList<UInt16> ActiveSymbolCounts

Control the length of barcodes to be decoded.

Call this function to enable decoding of long codes which can not be decoded with the default settings, or to optimize decoder performance for codes of certain lengths. This is useful when it is known that the application only requires scanning of particular barcode lengths.

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.