BarcodeFind View

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

FinishButtonTappedEventArgs
class FinishButtonTappedEventArgs : EventArgs

Added in version 6.21.0

Provides data for the BarcodeFindView.FinishButtonTapped event.

FinishButtonTappedEventArgs()
FinishButtonTappedEventArgs(ICollection<BarcodeFindItem> foundItems)

Added in version 6.21.0

FoundItems
ICollection<BarcodeFindItem> FoundItems { get; }

Added in version 6.21.0

BarcodeFindView
class BarcodeFindView : RelativeLayout

Added in version 6.21.0

BarcodeFind comes with a ready-to-use search UI that uses augmented reality overlays to highlight items that match predefined criteria. The BarcodeFindView integrates with any app in just a few lines of code.

Create()
static BarcodeFindView Create(View parentView, DataCaptureContext dataCaptureContext, BarcodeFind barcodeFind, BarcodeFindViewSettings settings)

Added in version 6.21.0

Constructs a new BarcodeFind view and adds it to the provided parentView. The provided settings will be used to set the default behaviour and look of the view.

OnResume()
void OnResume()

Added in version 6.21.0

Function to call on Fragment/Activity onResume callback. You have to call this for the correct functioning of the BarcodeFindView.

OnPause()
void OnPause()

Added in version 6.21.0

Function to call on Fragment/Activity onPause callback. You have to call this for the correct functioning of the BarcodeFindView.

StopSearching()
void StopSearching()

Added in version 6.21.0

Method to call for stopping the mode. For instance, it can be called when the view controller containing BarcodeFindView is about to disappear (i.e., UIViewController’s viewWillDisappear).

StartSearching()
void StartSearching()

Added in version 6.21.0

Starts the searching process. You can call this method if you want to trigger the searching process without any user interaction.

PauseSearching()
void PauseSearching()

Added in version 6.21.0

Pauses the searching process. You can call this method if you want to trigger pausing the searching process without any user interaction.

ShouldShowUserGuidanceView
bool ShouldShowUserGuidanceView { get;set; }

Added in version 6.21.0

Indicates whether guidance should be shown to the user.

Default is true.

ShouldShowHints
bool ShouldShowHints { get;set; }

Added in version 6.21.0

Indicates whether hints should be shown to the user.

Default is true.

ShouldShowCarousel
bool ShouldShowCarousel { get;set; }

Added in version 6.21.0

Indicates whether the item carousel should be shown to the user.

Default is true.

ShouldShowPauseButton
bool ShouldShowPauseButton { get;set; }

Added in version 6.21.0

Indicates whether the pause button should be shown to the user.

Default is true.

ShouldShowFinishButton
bool ShouldShowFinishButton { get;set; }

Added in version 6.21.0

Indicates whether the finish button should be shown to the user.

Default is true.

ShouldShowProgressBar
bool ShouldShowProgressBar { get;set; }

Added in version 6.21.0

Indicates whether the progress bar should be shown to the user.

Default is false.

ShouldShowTorchControl
bool ShouldShowTorchControl { get;set; }

Added in version 6.21.0

Indicates whether the torch control button should be shown to the user.

Default is false.

TorchControlPosition
Anchor TorchControlPosition { get;set; }

Added in version 6.21.0

Updates the position of the torch control button.

Only Anchor.TopLeft, Anchor.TopCenter, Anchor.TopRight and Anchor.BottomLeft are supported.

Any other value will default to Anchor.TopLeft.

TextForCollapseCardsButton
string TextForCollapseCardsButton { get;set; }

Added in version 6.21.0

Overrides the default text displayed in the button for collapsing the item carousel.

Default is null.

TextForAllItemsFoundSuccessfullyHint
string TextForAllItemsFoundSuccessfullyHint { get;set; }

Added in version 6.21.0

Overrides the default text displayed in the green confirmation view shown when all items have been found.

Default is null.

TextForPointAtBarcodesToSearchHint
string TextForPointAtBarcodesToSearchHint { get;set; }

Added in version 6.21.0

Overrides the default text for the “Point at barcodes to search” hint.

Default is null.

TextForMoveCloserToBarcodesHint
string TextForMoveCloserToBarcodesHint { get;set; }

Added in version 6.21.0

Overrides the default text for the “Move closer” hint.

Default is null.

TextForTapShutterToPauseScreenHint
string TextForTapShutterToPauseScreenHint { get;set; }

Added in version 6.21.0

Overrides the default text for “Tap shutter to pause” hint.

Default is null.

TextForTapShutterToResumeSearchHint
string TextForTapShutterToResumeSearchHint { get;set; }

Added in version 6.21.0

Overrides the default text for “Tap shutter to resume” hint.

Default is null.

FinishButtonTapped
event EventHandler<FinishButtonTappedEventArgs> FinishButtonTapped

Added in version 6.21.0

Occurs when the finish button is tapped from the view. The FinishButtonTappedEventArgs.FoundItems property contains all the items found since the start of the searching process. Called from the main thread.