Barcode Capture Overlay

Defined in namespace Scandit.DataCapture.Barcode.UI.Overlay

BarcodeCaptureOverlayStyle

Added in version 6.10.0

The style of the BarcodeCaptureOverlay.

Deprecated since version 6.26: This enum is deprecated and will be removed in the future.

Legacy

Added in version 6.10.0

Legacy style from versions before 6.10.

Frame

Added in version 6.10.0

Style that draws the highlights as a rectangular frame and adds an animation for when a code is scanned.

BarcodeCaptureOverlay

class BarcodeCaptureOverlay : IDataCaptureOverlay

Added in version 6.2.0

Overlay for the BarcodeCapture capture mode that displays recognized barcodes on top of a data capture view.

The appearance of the visualized barcodes can be configured or turned off completely through the Brush property.

Create()

static BarcodeCaptureOverlay Create(BarcodeCapture barcodeCapture, DataCaptureView view)

Added in version 6.2.0

Constructs a new barcode capture overlay for the provided barcode capture instance. When passing a non-null view instance, the overlay is automatically added to the view.

Create()

static BarcodeCaptureOverlay Create(BarcodeCapture barcodeCapture, DataCaptureView view, BarcodeCaptureOverlayStyle style)

Added in version 6.10.0

Constructs a new barcode capture overlay for the provided barcode capture instance and style. When passing a non-null view instance, the overlay is automatically added to the view.

FromJson()

static BarcodeCaptureOverlay FromJson(BarcodeCapture mode, string jsonData)

Added in version 6.3.0

Constructs a new barcode capture overlay with the provided JSON serialization.

For the overlay to be displayed on screen, it must be added to a DataCaptureView.

Create()

static BarcodeCaptureOverlay Create(BarcodeCapture barcodeCapture)

Added in version 6.2.0

Constructs a new barcode capture overlay for the provided barcode capture instance. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

Viewfinder

IViewfinder Viewfinder { get;set; }

Added in version 6.2.0

Set the viewfinder. By default, the viewfinder is null. Set this to an instance of IViewfinder if you want to draw a viewfinder.

Brush

Brush Brush { get;set; }

Added in version 6.2.0

The brush used for visualizing a recognized barcode in the UI. To turn off drawing of locations, set the brush to use both a transparent fill and stroke color. By default, the brush has a transparent fill color, a “Scandit”-blue stroke color, and a stroke width of 1.

DefaultBrush

static Brush DefaultBrush { get; }

Added in version 6.2.0

Returns the default brush used by the overlay.

Deprecated since version 6.10.0: The defaultBrush of the overlay depends on the style used, there is no unique default brush. Use Brush from a new overlay instance instead.

DefaultBrushForStyle()

static Brush DefaultBrushForStyle(BarcodeCaptureOverlayStyle style)

Added in version 6.11.0

Returns the default brush for the given style.

ShouldShowScanAreaGuides

bool ShouldShowScanAreaGuides { get;set; }

Added in version 6.2.0

Whether to show scan area guides on top of the preview. This property is useful during development to visualize the current scan areas on screen. It is not meant to be used for production. By default this property is false.

UpdateFromJson()

void UpdateFromJson(string jsonData)

Added in version 6.3.0

Updates the overlay according to a JSON serialization.

SetProperty()

void SetProperty(string name, object value)

Added in version 6.2.0

Set barcode capture overlay 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 or may not be used or change in a future release.

Style

BarcodeCaptureOverlayStyle Style { get; }

Added in version 6.10.0

The overlay style. Defaults to Legacy.