Barcode Selection Basic Overlay

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

BarcodeSelectionBasicOverlayStyle

Added in version 6.16.0

The style of the BarcodeSelectionBasicOverlay.

Frame

Added in version 6.16.0

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

Dot

Added in version 6.16.0

Style that draws the highlights as a dot and adds an animation for when a code newly appears.

IBarcodeSelectionBrushProvider

interface IBarcodeSelectionBrushProvider

Added in version 6.19.0

Interface for applying custom brushes to recognized barcodes.

BrushForBarcode()

Brush BrushForBarcode(Barcode barcode)

Added in version 6.19.0

Return the brush to apply to the given barcode. A non-null brush returned by this method overrides any other brush set for the barcode.

BarcodeSelectionBasicOverlay

class BarcodeSelectionBasicOverlay : IDataCaptureOverlay

Added in version 6.16.0

An overlay for DataCaptureView that shows a simple augmentation over each selected barcode.

To display the augmentations, this overlay must be attached to a DataCaptureView. This may be done either by creating it with Create() with a non-null view parameter or by passing this overlay to DataCaptureView.AddOverlay().

A user of this class may configure the appearance of the augmentations by configuring the brush properties.

Create()

static BarcodeSelectionBasicOverlay Create(BarcodeSelection barcodeSelection, DataCaptureView view)

Added in version 6.16.0

Constructs a new barcode selection basic overlay for the barcode selection instance. The overlay is automatically added to the view.

Create()

static BarcodeSelectionBasicOverlay Create(BarcodeSelection barcodeSelection, DataCaptureView view, BarcodeSelectionBasicOverlayStyle style)

Added in version 6.16.0

Constructs a new barcode selection basic overlay for the barcode selection instance with the specified style. The overlay is automatically added to the view.

Create()

static BarcodeSelectionBasicOverlay Create(BarcodeSelection barcodeSelection)

Added in version 6.16.0

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

Create()

static BarcodeSelectionBasicOverlay Create(BarcodeSelection barcodeSelection, BarcodeSelectionBasicOverlayStyle style)

Added in version 6.16.0

Constructs a new barcode selection basic overlay for the barcode selection instance with the specified style. For the overlay to be displayed on screen, it must be added to a DataCaptureView.

DefaultTrackedBrushForStyle()

static Brush DefaultTrackedBrushForStyle(BarcodeSelectionBasicOverlayStyle style)

Added in version 6.16.0

Returns the default tracked brush for the given style.

DefaultAimedBrushForStyle()

static Brush DefaultAimedBrushForStyle(BarcodeSelectionBasicOverlayStyle style)

Added in version 6.16.0

Returns the default aimed brush for the given style.

DefaultSelectedBrushForStyle()

static Brush DefaultSelectedBrushForStyle(BarcodeSelectionBasicOverlayStyle style)

Added in version 6.16.0

Returns the default selected brush for the given style.

DefaultSelectingBrushForStyle()

static Brush DefaultSelectingBrushForStyle(BarcodeSelectionBasicOverlayStyle style)

Added in version 6.16.0

Returns the default selecting brush for the given style.

TrackedBrush

Brush TrackedBrush { get;set; }

Added in version 6.16.0

The brush applied to recognized tracked barcodes. Setting this brush to Brush.TransparentBrush hides all tracked barcodes.

AimedBrush

Brush AimedBrush { get;set; }

Added in version 6.16.0

The brush applied to the barcode that is currently being aimed at.

SelectedBrush

Brush SelectedBrush { get;set; }

Added in version 6.16.0

The brush applied to selected barcodes. Setting this brush to Brush.TransparentBrush hides all selected barcodes.

SelectingBrush

Brush SelectingBrush { get;set; }

Added in version 6.16.0

The brush applied to the barcodes for the short moment when they are being selected.

ShouldShowScanAreaGuides

bool ShouldShowScanAreaGuides { get;set; }

Added in version 6.16.0

When set to true, this overlay will visualize the active scan area used for BarcodeSelection. This is useful to check margins defined on the DataCaptureView are set correctly. This property is meant for debugging during development and is not intended for use in production.

By default this property is false.

ShouldShowHints

bool ShouldShowHints { get;set; }

Added in version 6.16.0

When set to true, this overlay will visualize some hints explaining how to use barcode selection.

By default this property is true.

Viewfinder

IViewfinder Viewfinder { get; }

Added in version 6.16.0

The viewfinder of the overlay. The viewfinder is only visible when the selection type is BarcodeSelectionAimerSelection.

ClearSelectedBarcodeBrushes()

void ClearSelectedBarcodeBrushes()

Added in version 6.19.0

Clears all currently displayed visualizations for the on screen barcodes.

This only applies to the currently displayed barcodes, the visualizations for the new ones will still appear.

SetTextForSelectOrDoubleTapToFreezeHint()

void SetTextForSelectOrDoubleTapToFreezeHint(string text)

Added in version 6.19.0

Sets the text of the hint which suggests to use double tap gesture to freeze capture view.

SetTextForTapToSelectHint()

void SetTextForTapToSelectHint(string text)

Added in version 6.19.0

Sets the text of the hint which suggests to use tap gesture to select barcodes.

SetTextForDoubleTapToUnfreezeHint()

void SetTextForDoubleTapToUnfreezeHint(string text)

Added in version 6.19.0

Sets the text of the hint which suggests to use double tap gesture to unfreeze capture view.

SetTextForTapAnywhereToSelectHint()

void SetTextForTapAnywhereToSelectHint(string text)

Added in version 6.19.0

Sets the text of the hint which suggests to use tap gesture anywhere on the screen to select.

SetTextForAimToSelectAutoHint()

void SetTextForAimToSelectAutoHint(string text)

Added in version 6.19.0

Sets the text of the hint which suggests to aim at a barcode to scan it.

SetAimedBarcodeBrushProvider()

void SetAimedBarcodeBrushProvider(IBarcodeSelectionBrushProvider brushProvider)

Added in version 6.19.0

Sets the brush provider for aimed barcode.

SetTrackedBarcodeBrushProvider()

void SetTrackedBarcodeBrushProvider(IBarcodeSelectionBrushProvider brushProvider)

Added in version 6.19.0

Sets the brush provider for tracked barcode.

FrozenBackgroundColor

Color FrozenBackgroundColor { get;set; }

Added in version 6.19.0

The overlay’s background color when in frozen state. This color will be on top of the video preview but below the highlights. Semitransparent black by default.

Style

BarcodeSelectionBasicOverlayStyle Style { get; }

Added in version 6.16.0

The overlay style. Defaults to Frame.