Label Capture Settings

Defined in namespace Scandit.DataCapture.Label.Capture

LabelCaptureSettings

class LabelCaptureSettings : IDisposable

Added in version 8.1.0

Configures label capture parameters and defines the structure of labels to be captured. This settings object is central to the Smart Label Capture workflow, specifying which label definitions to use, recognition parameters, and capture behavior.

Key configuration aspects:

Label definitions - Defines field types (barcodes, dates, text) and their validation rules
Recognition parameters - Controls scanning behavior and accuracy
Location selection - Specifies scanning areas and constraints
Symbology settings - Configures which barcode types are enabled

The settings follow a fluent builder pattern for convenient configuration and support multiple label definitions to handle different types of labels in the same scanning session. For the settings to take effect, they must be applied to a label capture instance using the appropriate apply settings method.

Create()

static LabelCaptureSettings Create(IList<LabelDefinition> definitions)

Added in version 8.1.0

Load the settings from an array of LabelDefinition

LocationSelection

ILocationSelection LocationSelection { get;set; }

Added in version 8.1.0

Defines the strategy with which to select one out of many visible labels. By default, this property is null and label selection is disabled.

Currently only RectangularLocationSelection is supported.

SetProperty()

void SetProperty(string name, object value)

Added in version 8.1.0

Sets a property to the provided value. Use this method to set properties that are not yet part of a stable API. Properties set through this method may change in a future release.

GetProperty()

object GetProperty(string name)

Added in version 8.1.0

Retrieves the value of a previously set property. In case the property does not exist, null is returned. Use this method to get properties that are not yet part of a stable API. These properties may change in a future release.

GetProperty()

T GetProperty<T>(string name)

Added in version 8.1.0

Retrieves the value of a previously set property. In case the property does not exist, an ArgumentException is thrown.

TryGetProperty()

bool TryGetProperty<T>(string name, out T result)

Added in version 8.1.0

The non-throwing version of the method GetProperty(). It retrieves the value of a previously set property as the second passed argument and returns true. In case the property does not exist, false will be returned.

GetSymbologySettings()

SymbologySettings GetSymbologySettings(Symbology symbology)

Added in version 8.1.0

Get SymbologySettings specific for the given Symbology.

Note that modifying the returned object doesn’t automatically apply the changes to LabelCapture. After you made changes to the symbology settings, call LabelCapture.ApplySettingsAsync() with these LabelCaptureSettings to apply them.