Barcode Count View
Defined in namespace Scandit.DataCapture.Barcode.Count.UI
- BarcodeCountViewStyle
Added in version 6.18.0
The style of the BarcodeCountView
- Icon
Added in version 6.18.0
Style that draws the highlights as icons and adds an animation for when a code newly appears.
- Dot
Added in version 6.18.0
Style that draws the highlights as a dot and adds an animation for when a code newly appears.
- BarcodeCountView
class BarcodeCountView : View
Added in version 6.18.0
BarcodeCount comes with a ready-to-use UI. Add BarcodeCountView to the view hierarchy. Please note that this view should be presented full screen.
- BarcodeCountView()
BarcodeCountView()
Added in version 6.17.0
Constructs a new BarcodeCount view. The DataCaptureContext and BarcodeCount must be provided by setting the DataCaptureContext and BarcodeCount properties.
- DataCaptureContext
DataCaptureContext DataCaptureContext { get;set; }
Added in version 6.17.0
The data capture context of this barcode count view. This property must be set to an instance of the data capture context for this view to display anything.
- BarcodeCount
BarcodeCount BarcodeCount { get;set; }
Added in version 6.17.0
The barcode count mode of this barcode count view. This property must be set to an instance of the barcode count for this view to display anything.
- ShouldShowUserGuidanceView
bool
ShouldShowUserGuidanceView { get;set; }Added in version 6.18.0
When set to true, user guidance and the loading view will be shown to the user. The user guidance prompts the user to scan, and to move closer or further away from the target barcodes in order to scan them properly.
By default this property is true.
- ShouldShowListProgressBar
bool
ShouldShowListProgressBar { get;set; }Added in version 6.25.0
When set to true, a progress bar will be shown to the user when a capture list has been set using BarcodeCount.SetBarcodeCountCaptureList(), indicating how many of the barcodes in the list have been scanned.
By default this property is true.
- ShouldShowListButton
bool
ShouldShowListButton { get;set; }Added in version 6.18.0
When set to true, a list button will be shown to the user in the lower left hand corner of the screen. When tapped, this button will freeze the mode. This button triggers ListButtonTapped event.
By default this property is true.
- ShouldShowExitButton
bool
ShouldShowExitButton { get;set; }Added in version 6.18.0
When set to true, an exit button will be shown in the lower right hand corner of the screen. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers ExitButtonTapped event.
By default this property is true.
- ShouldShowShutterButton
bool
ShouldShowShutterButton { get;set; }Added in version 6.18.0
When set to true, a shutter button will be shown to the user centered in the bottom of the screen. This button triggers the processing of the current video feed. The same functionality can be triggered by calling BarcodeCount.StartScanningPhase().
By default this property is true.
- ShouldShowHints
bool
ShouldShowHints { get;set; }Added in version 6.18.0
When set to true, this view will show some messages about currently scanned barcodes.
By default this property is true.
- ShouldShowClearHighlightsButton
bool
ShouldShowClearHighlightsButton { get;set; }Added in version 6.18.0
When set to true, a button will be shown above the default shutter button. This button clears all currently shown barcodes highlights. The same functionality can be triggered by calling ClearHighlights().
By default this property is false.
- ShouldShowSingleScanButton
bool
ShouldShowSingleScanButton { get;set; }Added in version 6.18.0
When set to true, a button will be shown to the user in the lower left corner of the preview. The behavior for this button is left entirely to the developer, and does nothing by default. When clicked, this button triggers SingleScanButtonTapped event.
By default this property is false.
- ShouldShowStatusModeButton
bool
ShouldShowStatusModeButton { get;set; }Added in version 6.18.0
When set to true, a button will be shown to the user in the lower right corner of the preview. This button toggles “status mode”, in which the normal barcode highlights will be replaced by status indicators for each barcode. The status for each barcode must be provided via a IBarcodeCountStatusProvider previously set with SetStatusProvider(). If no IBarcodeCountStatusProvider is set, clicking this button has no effect.
By default this property is false.
Note
The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.
- ShouldShowFloatingShutterButton
bool
ShouldShowFloatingShutterButton { get;set; }Added in version 6.18.0
When set to true, a floating shutter button will be visible on screen. This button can be dragged to any position and, when tapped, will trigger the processing of the current video feed.
By default this property is false.
- ShouldShowToolbar
bool
ShouldShowToolbar { get;set; }Added in version 6.18.0
When set to true, a collapsable toolbar will be visible at the top of the preview. This toolbar contains a set of convenience buttons for easy preference setting during scanning.
By default this property is true.
- SetToolbarSettings()
void
SetToolbarSettings(BarcodeCountToolbarSettings settings)Added in version 6.18.0
Pass an instance of BarcodeCountToolbarSettings to configure the text and accessibility options for the toolbar.
- SetStatusProvider()
void
SetStatusProvider(IBarcodeCountStatusProvider provider)Added in version 6.18.0
Sets a IBarcodeCountStatusProvider for this view. This provider will be queried when the “status mode” button is clicked.
Note
The Barcode Count status mode API is still in beta and may change in future versions of Scandit Data Capture SDK.
- Listener
IBarcodeCountViewListener Listener { get;set; }
Added in version 6.18.0
The listener which is called whenever a new TrackedBarcode is newly tracked or newly recognized.
Note
Using this listener requires the MatrixScan AR add-on.
- DefaultRecognizedBrush
static Brush DefaultRecognizedBrush { get; }
Added in version 6.18.0
Returns the default brush to use for a recognized barcode. When setting a BarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Only used when setting the view Style to BarcodeCountViewStyle.Dot.
- DefaultUnrecognizedBrush
static Brush DefaultUnrecognizedBrush { get; }
Added in version 6.18.0
Returns the default brush to use for an unrecognized barcode. Only used when setting the view Style to BarcodeCountViewStyle.Dot.
- DefaultNotInListBrush
static Brush DefaultNotInListBrush { get; }
Added in version 6.18.0
Returns the default brush to use for a recognized barcode that’s not part of the target BarcodeCountCaptureList. Only used when setting the view Style to BarcodeCountViewStyle.Dot.
- RecognizedBrush
Brush RecognizedBrush { get;set; }
Added in version 6.18.0
The brush applied to recognized tracked barcodes if IBarcodeCountViewListener is not implemented. When setting a BarcodeCountCaptureList to the mode, this brush will be used for recognized barcodes that are part of the target list. Setting this brush to null hides all tracked barcodes.
Used only when the view uses the BarcodeCountViewStyle.Dot style.
- UnrecognizedBrush
Brush UnrecognizedBrush { get;set; }
Added in version 6.18.0
The brush applied to unrecognized tracked barcodes if IBarcodeCountViewListener is not implemented. Setting this brush to null hides all tracked barcodes.
Used only when the view uses the BarcodeCountViewStyle.Dot style.
- NotInListBrush
Brush NotInListBrush { get;set; }
Added in version 6.18.0
The brush applied to recognized tracked barcodes that are not part of the target BarcodeCountCaptureList, and only if IBarcodeCountViewListener is not implemented. When BarcodeCountCaptureList is not set, this method will never be called. Setting this brush to null hides all tracked barcodes.
Used only when the view uses the BarcodeCountViewStyle.Dot style.
- ShouldShowScanAreaGuides
bool
ShouldShowScanAreaGuides { get;set; }Added in version 6.18.0
When set to true, this view will visualize the active scan area used for BarcodeCount. 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.
- Style
BarcodeCountViewStyle Style { get; }
Added in version 6.18.0
The view style. Defaults to BarcodeCountViewStyle.Dot.
- ListButtonAccessibilityLabel
string
ListButtonAccessibilityLabel { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility label for the list button provided by the view.
This property has effect only when running on iOS.
- ExitButtonAccessibilityLabel
string
ExitButtonAccessibilityLabel { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility label for the exit button provided by the view.
This property has effect only when running on iOS.
- ShutterButtonAccessibilityLabel
string
ShutterButtonAccessibilityLabel { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility label for the shutter button provided by the view.
This property has effect only when running on iOS.
- FloatingShutterButtonAccessibilityLabel
string
FloatingShutterButtonAccessibilityLabel { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility label for the floating shutter button provided by the view.
This property has effect only when running on iOS.
- SingleScanButtonAccessibilityLabel
string
SingleScanButtonAccessibilityLabel { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility label for the single scan button provided by the view.
This property has effect only when running on iOS.
- ClearHighlightsButtonAccessibilityLabel
string
ClearHighlightsButtonAccessibilityLabel { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility label for the clear highlights button provided by the view.
This property has effect only when running on iOS.
- StatusModeButtonAccessibilityLabel
string
StatusModeButtonAccessibilityLabel { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility label for the single status mode button provided by the view.
This property has effect only when running on iOS.
- ListButtonAccessibilityHint
string
ListButtonAccessibilityHint { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility hint for the list button provided by the view.
This property has effect only when running on iOS.
- ExitButtonAccessibilityHint
string
ExitButtonAccessibilityHint { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility hint for the exit button provided by the view.
This property has effect only when running on iOS.
- ShutterButtonAccessibilityHint
string
ShutterButtonAccessibilityHint { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility hint for the shutter button provided by the view.
This property has effect only when running on iOS.
- FloatingShutterButtonAccessibilityHint
string
FloatingShutterButtonAccessibilityHint { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility hint for the floating shutter button provided by the view.
This property has effect only when running on iOS.
- ClearHighlightsButtonAccessibilityHint
string
ClearHighlightsButtonAccessibilityHint { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility hint for the clear highlights button provided by the view.
This property has effect only when running on iOS.
- SingleScanButtonAccessibilityHint
string
SingleScanButtonAccessibilityHint { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility hint for the single scan button provided by the view.
This property has effect only when running on iOS.
- StatusModeButtonAccessibilityHint
string
StatusModeButtonAccessibilityHint { get;set; }Added in version 6.18.0
Use this property to access or modify the accessibility hint for the status mode button provided by the view.
This property has effect only when running on iOS.
- StatusModeButtonContentDescription
string
StatusModeButtonContentDescription { get;set; }Added in version 6.18.0
Gets or sets the content description for the status mode button provided by the view.
This property has effect only when running on Android.
- ClearHighlightsButtonText
string
ClearHighlightsButtonText { get;set; }Added in version 6.18.0
Use this property to access or modify the text of the clear button label provided by the view.
- ListButtonContentDescription
string
ListButtonContentDescription { get;set; }Added in version 6.18.0
Use this property to access or modify the content description of the list button provided by the view.
This property has effect only when running on Android.
- ExitButtonContentDescription
string
ExitButtonContentDescription { get;set; }Added in version 6.18.0
Use this property to access or modify the content description of the exit button provided by the view.
This property has effect only when running on Android.
- ShutterButtonContentDescription
string
ShutterButtonContentDescription { get;set; }Added in version 6.18.0
Use this property to access or modify the content description of the shutter button provided by the view.
This property has effect only when running on Android.
- ClearHighlightsButtonContentDescription
string
ClearHighlightsButtonContentDescription { get;set; }Added in version 6.18.0
Use this property to access or modify the content description of the “clear highlights” button provided by the view.
This property has effect only when running on Android.
- SingleScanButtonContentDescription
string
SingleScanButtonContentDescription { get;set; }Added in version 6.18.0
Use this property to access or modify the content description of the “single scan” button provided by the view.
This property has effect only when running on Android.
- FloatingShutterButtonContentDescription
string
FloatingShutterButtonContentDescription { get;set; }Added in version 6.18.0
Use this property to access or modify the content description for the floating shutter button provided by the view.
This property has effect only when running on Android.
- TextForUnrecognizedBarcodesDetectedHint
string
TextForUnrecognizedBarcodesDetectedHint { get;set; }Added in version 6.18.0
Use this property to access or modify the text of the hint displayed when one or more unrecognized barcodes are detected.
- TextForTapShutterToScanHint
string
TextForTapShutterToScanHint { get;set; }Added in version 6.18.0
Use this property to access or modify the text of the hint which suggests to tap the shutter button.
- TextForScanningHint
string
TextForScanningHint { get;set; }Added in version 6.18.0
Use this property to access or modify the text of the hint displayed while scanning is in progress.
- TextForMoveCloserAndRescanHint
string
TextForMoveCloserAndRescanHint { get;set; }Added in version 6.18.0
Use this property to access or modify the text of the hint displayed when camera should be moved closer to rescan.
- TextForMoveFurtherAndRescanHint
string
TextForMoveFurtherAndRescanHint { get;set; }Added in version 6.18.0
Use this property to access or modify the text of the hint displayed when camera should be further away to rescan.
- ExitButtonText
string
ExitButtonText { get;set; }Added in version 6.18.0
Use this property to access or modify the text of the exit button label provided by the view.
- FilterSettings
IBarcodeFilterHighlightSettings FilterSettings { get;set; }
Added in version 6.18.0
Use this property to access or modify the current view settings for barcode filtering.
- ClearHighlights()
void
ClearHighlights()Added in version 6.18.0
Clear all currently shown barcodes highlights. This only affects screen rendering, and all detected barcodes will still be available in the BarcodeCountSession.
- ExitButtonTapped
event EventHandler<ExitButtonTappedEventArgs> ExitButtonTapped
Added in version 6.18.0
Occurs when the exit button is tapped. Called from the main thread.
- ListButtonTapped
event EventHandler<ListButtonTappedEventArgs> ListButtonTapped
Added in version 6.18.0
Occurs when the list button is tapped. Called from the main thread.
- SingleScanButtonTapped
event EventHandler<SingleScanButtonTappedEventArgs> SingleScanButtonTapped
Added in version 6.18.0
Occurs when the single scan button is tapped. Called from the main thread.
- ViewInitialized
event EventHandler ViewInitialized
Added in version 6.18.0
Occurs when initialization of this barcode count view is completed.