Deprecation warning

Please note that this is outdated documentation for an older release of the Scandit Barcode Scanner SDK.

We are deprecating the 5.x API on all platforms (except Linux). Release 5.19 in April 2021 will be our final. Applications running 5.x will continue to work, and we will continue to release critical bug fixes and security patches only, for one year. We encourage you to migrate to 6.x and take advantage of our latest / advanced features and improved performance.

You'll find the updated documentation at: Data Capture SDK Documentation for Xamarin.Android and Data Capture SDK Documentation for Xamarin.iOS

SymbologySettings Class Reference

Public Member Functions

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

Properties

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

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

Determine whether a certain extension is currently enabled.

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

Property Documentation

bool Enabled
getset

Whether decoding of this symbology is enabled.

bool ColorInvertedEnabled
getset

Whether color-inverted decoding of this symbology is enabled.

Checksum Checksums
getset

Optional checksums enabled for this symbology.

IReadOnlyList<UInt16> ActiveSymbolCounts
getset

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.