Barcode Sequence View

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

BarcodeSequenceState

Added in version 8.6.0

The possible states of the BarcodeSequenceView.

Initialized

Added in version 8.6.0

The view has been initialized and is ready to start sequencing.

InitializedWithWrongOrientation

Added in version 8.6.0

The view has been initialized but not ready to begin sequencing because the device is held in the wrong orientation.

InitializedWithDeviceNotFacingShelf

Added in version 8.6.0

The view has been initialized but not ready to begin sequencing because the device is not held facing the shelf.

Sequencing

Added in version 8.6.0

The view is actively sequencing.

Paused

Added in version 8.6.0

The sequencing process has been paused.

PausedDueToInactivity

Added in version 8.6.0

The sequencing process has been paused automatically due to user inactivity.

PausedDueToOrientationChange

Added in version 8.6.0

The sequencing process has been paused due to the device being held in the wrong orientation.

PausedDueToDeviceNotFacingShelf

Added in version 8.6.0

The sequencing process has been paused due to the device not being held facing the shelf.

Stopped

Added in version 8.6.0

The sequencing process has been stopped.

Error

Added in version 8.6.0

The sequencing process encountered an error. The error will be displayed on the view.

IBarcodeSequenceViewUIListener

interface IBarcodeSequenceViewUIListener

Added in version 8.6.0

OnNextButtonTapped()

void OnNextButtonTapped(BarcodeSequenceView view, SequencedShelfModule sequencedShelfModule)

Added in version 8.6.0

Callback method that is called when the next button is tapped in the view with the sequenced shelf module. Module may be null.

OnViewListButtonTapped()

void OnViewListButtonTapped(BarcodeSequenceView view, SequencedShelfModule sequencedShelfModule)

Added in version 8.6.0

Callback method that is called when the view list button is tapped in the view with the sequenced shelf module. Module may be null.

OnStateChanged()

void OnStateChanged(BarcodeSequenceView view, BarcodeSequenceState state)

Added in version 8.6.0

Callback method that is called when the BarcodeSequenceView state changes.

BarcodeSequenceView

class BarcodeSequenceView : IDisposable

Added in version 8.6.0

Barcode Sequence comes with a ready-to-use UI that allows highlighting barcodes and trays and building a shelf module. The BarcodeSequenceView integrates with any app in just a few lines of code.

Create()

static BarcodeSequenceView Create(View parentView, BarcodeSequence mode, CameraSettings cameraSettings)

Added in version 8.6.0

Creates a new BarcodeSequenceView with the provided mode and camera settings. The view settings can be configured directly on the view.

Create()

static BarcodeSequenceView Create(View parentView, BarcodeSequence mode)

Added in version 8.6.0

Creates a new BarcodeSequenceView with the provided mode and default camera settings from BarcodeSequence.RecommendedCameraSettings. The view settings can be configured directly on the view.

SoundEnabled

bool SoundEnabled { get;set; }

Added in version 8.6.0

Indicates whether the feedback should have sound enabled. Can be changed while the view is in use.

Default is true.

HapticEnabled

bool HapticEnabled { get;set; }

Added in version 8.6.0

Indicates whether the feedback should have haptics enabled. Can be changed while the view is in use.

Default is true.

ShouldShowInitialGuidance

bool ShouldShowInitialGuidance { get;set; }

Added in version 8.6.0

Indicates whether an initial guidance UI should be presented when the view starts. Disabling the setting right after creating the view prevents the guidance from appearing; disabling it while the guidance is visible hides it. Re-enabling it after the guidance has been dismissed has no effect.

Default is true.

TrayIndicatorLineColor

int TrayIndicatorLineColor { get;set; }

Added in version 8.6.0

Color used for the tray indicator line. Can be changed while the view is in use; visible tray indicators are updated immediately.

Default is #0062FF.

TrayIndicatorLineSize

float TrayIndicatorLineSize { get;set; }

Added in version 8.6.0

The thickness of the tray indicator line in device-independent pixels. Can be changed while the view is in use; visible tray indicators are updated immediately.

Default is 4.

TrayIndicatorText

string TrayIndicatorText { get;set; }

Added in version 8.6.0

The label text for the tray indicator. The value should contain a placeholder like "Row %d". Can be changed while the view is in use; visible tray indicators are updated immediately.

Default is "Row %d".

HighlightBrush

Brush HighlightBrush { get;set; }

Added in version 8.6.0

Brush used to render highlights for tracked and sequenced barcodes. Can be changed while the view is in use; visible highlights are updated immediately.

Default is a brush with #0062FF fill color, #FFFFFF stroke color and 2f stroke width.

HighlightTextColor

int HighlightTextColor { get;set; }

Added in version 8.6.0

Text color used for highlight labels. Can be changed while the view is in use; visible highlights are updated immediately.

Default is #FFFFFF.

UiListener

IBarcodeSequenceViewUIListener UiListener { get;set; }

Added in version 8.6.0

Sets the listener which is called whenever buttons are tapped in the view.

State

BarcodeSequenceState State { get; }

Added in version 8.6.0

The current state of the BarcodeSequenceView.

SequencedShelfModule

SequencedShelfModule SequencedShelfModule { get; }

Added in version 8.6.0

The current sequenced shelf module.

Note

For performance reasons, this property is updated only when the sequencing process is paused, and should be accessed only after pausing.

ShouldShowTorchControl

bool ShouldShowTorchControl { get;set; }

Added in version 8.6.0

Indicates whether the torch control button should be shown.

Default is true.

TorchControlPosition

Anchor TorchControlPosition { get;set; }

Added in version 8.6.0

Updates the position of the torch control button.

Default is Anchor.TopLeft.

InitialGuidanceTitleText

string InitialGuidanceTitleText { get;set; }

Added in version 8.6.0

The title text for the initial guidance tutorial dialog.

Default is “Scan all codes in a shelf”.

InitialGuidanceDescriptionText

string InitialGuidanceDescriptionText { get;set; }

Added in version 8.6.0

The description text for the initial guidance tutorial dialog.

Default is “For best results, use landscape mode and scan each row from left to right pausing in between rows.”.

InitialGuidanceButtonText

string InitialGuidanceButtonText { get;set; }

Added in version 8.6.0

The button text for the initial guidance tutorial dialog.

Default is “OK”.

RotateDeviceToCaptureText

string RotateDeviceToCaptureText { get;set; }

Added in version 8.6.0

PointShelfToCaptureText

string PointShelfToCaptureText { get;set; }

Added in version 8.6.0

The text displayed in the rotation prompt when the device is not facing the shelf and needs to be rotated towards it for sequencing.

Default is “Point the shelf to capture”.

ShouldShowViewListButton

bool ShouldShowViewListButton { get;set; }

Added in version 8.6.0

Whether the View List button is shown.

Default is true.

ShouldShowNextButton

bool ShouldShowNextButton { get;set; }

Added in version 8.6.0

Whether the Next button is shown.

Default is true.

ShouldShowRedoButton

bool ShouldShowRedoButton { get;set; }

Added in version 8.6.0

Whether the Redo button is shown.

Default is true.

ShouldShowShutterButton

bool ShouldShowShutterButton { get;set; }

Added in version 8.6.0

Whether the shutter button is shown.

Default is true.

ShouldShowTrayIndicatorText

bool ShouldShowTrayIndicatorText { get;set; }

Added in version 8.6.0

Whether the per-row tray indicator label (for example “Row 1”) is drawn on top of each captured tray. The tray indicator line itself is unaffected.

Default is true.

NextButtonText

string NextButtonText { get;set; }

Added in version 8.6.0

The text for the Next button.

Default is “Next”.

RedoButtonText

string RedoButtonText { get;set; }

Added in version 8.6.0

The text for the Redo button.

Default is “Redo”.

ViewListButtonText

string ViewListButtonText { get;set; }

Added in version 8.6.0

The text for the View List button.

Default is “View List”.

RedoShelfDialogTitleText

string RedoShelfDialogTitleText { get;set; }

Added in version 8.6.0

The title text for the redo confirmation dialog.

Default is “Redo Shelf”.

RedoShelfDialogDescriptionText

string RedoShelfDialogDescriptionText { get;set; }

Added in version 8.6.0

The description text for the redo confirmation dialog.

Default is “Your current capture will be cleared. Do you want to start a new capture?”.

RedoShelfDialogAcceptButtonText

string RedoShelfDialogAcceptButtonText { get;set; }

Added in version 8.6.0

The accept button text for the redo confirmation dialog.

Default is “Redo”.

RedoShelfDialogCancelButtonText

string RedoShelfDialogCancelButtonText { get;set; }

Added in version 8.6.0

The cancel button text for the redo confirmation dialog.

Default is “Cancel”.

RemoveBarcodeButtonText

string RemoveBarcodeButtonText { get;set; }

Added in version 8.6.0

The text for the remove barcode button in popover annotation.

Default is “Remove”.

AddBarcodeButtonText

string AddBarcodeButtonText { get;set; }

Added in version 8.6.0

The text for the add barcode button in popover annotation.

Default is “Add”.

LogoStyle

LogoStyle LogoStyle { get;set; }

Added in version 8.6.0

The style of the logo, either the extended “Scanning By Scandit” or the minimal “Scandit”.

Default is LogoStyle.Extended.

LogoAnchor

Anchor LogoAnchor { get;set; }

Added in version 8.6.0

The anchor point used to position the Scandit logo.

Default is Anchor.BottomRight.

Start()

void Start()

Added in version 8.6.0

This method starts the camera but does not begin the sequencing process. The sequencing process will start when the user taps the shutter button.

StartSequencing()

void StartSequencing()

Added in version 8.6.0

This method starts the sequencing process. It can be paused using PauseSequencing().

PauseSequencing()

void PauseSequencing()

Added in version 8.6.0

Pauses the sequencing process but keeps the camera running. It can be started again using StartSequencing().

Stop()

void Stop()

Added in version 8.6.0

Stops the camera and the sequencing process. It can be started again using Start().

Reset()

void Reset()

Added in version 8.6.0

Clears UI state and resets the view.