Class BarcodeScannerConfiguration

Namespace

ScanbotSDK.MAUI.Barcode

Assembly

ScanbotSDK.Shared.dll

Configuration of the scanning behavior.

public class BarcodeScannerConfiguration

Inheritance

object

BarcodeScannerConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AustraliaPostCustomerFormat

The customer format used in AUSTRALIA_POST codes. The default value is ALPHA_NUMERIC.

Default is ALPHA_NUMERIC

public AustraliaPostCustomerFormat AustraliaPostCustomerFormat { get; set; }

Property Value

AustraliaPostCustomerFormat

BarcodeFormats

List of accepted barcode symbologies.

Defaults to common types.

public BarcodeFormat[] BarcodeFormats { get; set; }

Property Value

BarcodeFormat[]

BarcodesRegexFilter

Regular expression filter for barcode text. If the barcode text does not match the regular expression, it will not be scanned. The default is an empty string (setting is turned off). This option overrides barcodesExtensionFilter option.

Default is ""

public string BarcodesRegexFilter { get; set; }

Property Value

string

Extensions

Filter for extended EAN and UPC barcodes.

Default is ALLOW_ANY

public UpcEanExtensionBehavior Extensions { get; set; }

Property Value

UpcEanExtensionBehavior

ExtractedDocumentFormats

List of document formats to be extracted.

Defaults to all document formats.

public BarcodeDocumentFormat[] ExtractedDocumentFormats { get; set; }

Property Value

BarcodeDocumentFormat[]

Gs1Handling

The expected way of handling GS1_COMPOSITE barcodes.

Default is PARSE

public Gs1Handling Gs1Handling { get; set; }

Property Value

Gs1Handling

LowPowerMode

If true, enables a mode that slightly decreases scanning quality and energy consumption. Increases scanning speed. If false, the mode is disabled. The default is false. Android only.

Default is false

public bool LowPowerMode { get; set; }

Property Value

bool

MaximumTextLength

Optional maximum text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.

Default is 0

public int MaximumTextLength { get; set; }

Property Value

int

Minimum1DBarcodesQuietZone

Optional minimum required quiet zone on the barcode. Measured in modules (the smallest bar size on a barcode). The default is 10. NOTE - This feature works on ITF barcodes only.

Default is 10

public int Minimum1DBarcodesQuietZone { get; set; }

Property Value

int

MinimumSizeScore

Minimum acceptable value of a result BarcodeItem's sizeScore (between 0 and 1). Barcodes with a sizeScore less than this value will not be scanned. When set to 0, barcodes are returned no matter what their size is.

Default is 0

public double MinimumSizeScore { get; set; }

Property Value

double

MinimumTextLength

Optional minimum required text length of the detected barcode. The default is 0 (setting is turned off). NOTE - This feature works on ITF barcodes only.

Default is 0

public int MinimumTextLength { get; set; }

Property Value

int

MsiPlesseyChecksumAlgorithm

Checksum algorithm used for MSI Plessey barcodes. The default value is MOD_10.

Default is MOD_10

public MsiPlesseyChecksumAlgorithm MsiPlesseyChecksumAlgorithm { get; set; }

Property Value

MsiPlesseyChecksumAlgorithm

OnlyAcceptDocuments

If true and extractedDocumentFormats is not empty, then barcodes that do not decode to one of the accepted document formats will be ignored.

Default is false

public bool OnlyAcceptDocuments { get; set; }

Property Value

bool

ReturnBarcodeImage

If true, the barcode image is returned in the result.

Default is true

public bool ReturnBarcodeImage { get; set; }

Property Value

bool

StripCheckDigits

If true, check digits for UPC, EAN and MSI Plessey codes are removed from the result. Has no effect if both single and double digit MSI Plessey checksums are enabled. The default is false.

Default is false

public bool StripCheckDigits { get; set; }

Property Value

bool

UseCode11Checksum

If true, the optional check digit for CODE_11 codes is used in validation. The default is true.

Default is true

public bool UseCode11Checksum { get; set; }

Property Value

bool

UseIATA2OF5Checksum

If true, the optional check digit for IATA_2_OF_5 codes is used in validation. The default is true.

Default is true

public bool UseIATA2OF5Checksum { get; set; }

Property Value

bool

Methods

FromJson(string)

public static BarcodeScannerConfiguration FromJson(string rawJson)

Parameters

rawJson string

Returns

BarcodeScannerConfiguration