Click or drag to resize

ScanOverlay Class

Scan UI on top of the video preview stream.
Inheritance Hierarchy

Namespace:  Scandit.BarcodePicker
Assembly:  Scandit.BarcodePicker (in Scandit.BarcodePicker.dll) Version: 5.18.0.10 (5.18.0.10)
Syntax
public class ScanOverlay : Panel, 
	INotifyPropertyChanged

The ScanOverlay type exposes the following members.

Constructors
  NameDescription
Public methodScanOverlay
Construct new ScanOverlay
Top
Properties
  NameDescription
Public propertyActualHeight
Gets the rendered height of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyActualWidth
Gets the rendered width of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyAllowDrop
Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.
(Inherited from UIElement.)
Public propertyBackground
Gets or sets a Brush that is used to fill the panel.
(Inherited from Panel.)
Public propertyBaseUri
Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time.
(Inherited from FrameworkElement.)
Public propertyCacheMode
Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.
(Inherited from UIElement.)
Public propertyCameraSwitchVisibility
Controls the visibility of the camera switch button
Public propertyChangeCameraStatus
For internal use only
Public propertyChildren
Gets the collection of child elements of the panel.
(Inherited from Panel.)
Public propertyChildrenTransitions
Gets or sets the collection of Transition style elements that apply to child content of a Panel subclass.
(Inherited from Panel.)
Public propertyClip
Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.
(Inherited from UIElement.)
Public propertyCompositeMode
Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.
(Inherited from UIElement.)
Public propertyDataContext
Gets or sets the data context for a FrameworkElement when it participates in data binding.
(Inherited from FrameworkElement.)
Public propertyDesiredSize
Gets the size that this UIElement computed during the measure pass of the layout process.
(Inherited from UIElement.)
Public propertyDispatcher
Gets the CoreDispatcher that this object is associated with.
(Inherited from DependencyObject.)
Public propertyFlowDirection
Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.
(Inherited from FrameworkElement.)
Public propertyGuiStyle
Controls the scan UI style
Public propertyHeight
Gets or sets the suggested height of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyHorizontalAlignment
Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.
(Inherited from FrameworkElement.)
Public propertyIsDoubleTapEnabled
Gets or sets a value that determines whether the DoubleTapped event can originate from that element.
(Inherited from UIElement.)
Public propertyIsHitTestVisible
Gets or sets whether the contained area of this UIElement can return true values for hit testing.
(Inherited from UIElement.)
Public propertyIsHoldingEnabled
Gets or sets a value that determines whether the Holding event can originate from that element.
(Inherited from UIElement.)
Public propertyIsItemsHost
Gets a value that indicates whether this Panel is a container for UI items that are generated by an ItemsControl.
(Inherited from Panel.)
Public propertyIsRightTapEnabled
Gets or sets a value that determines whether the RightTapped event can originate from that element.
(Inherited from UIElement.)
Public propertyIsTapEnabled
Gets or sets a value that determines whether the Tapped event can originate from that element.
(Inherited from UIElement.)
Public propertyLanguage
Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.
(Inherited from FrameworkElement.)
Public propertyLaserColor
Controls the color of the laser line
Public propertyManipulationMode
Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures.
(Inherited from UIElement.)
Public propertyMargin
Gets or sets the outer margin of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMaxHeight
Gets or sets the maximum height constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMaxWidth
Gets or sets the maximum width constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMinHeight
Gets or sets the minimum height constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyMinWidth
Gets or sets the minimum width constraint of a FrameworkElement.
(Inherited from FrameworkElement.)
Public propertyName
Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.
(Inherited from FrameworkElement.)
Public propertyOpacity
Gets or sets the degree of the object's opacity.
(Inherited from UIElement.)
Public propertyParent
Gets the parent object of this FrameworkElement in the object tree.
(Inherited from FrameworkElement.)
Public propertyPointerCaptures
Gets the set of all captured pointers, represented as Pointer values.
(Inherited from UIElement.)
Public propertyProjection
Gets or sets the perspective projection (3-D effect) to apply when rendering this element.
(Inherited from UIElement.)
Public propertyRenderSize
Gets the final render size of a UIElement.
(Inherited from UIElement.)
Public propertyRenderTransform
Gets or sets transform information that affects the rendering position of a UIElement.
(Inherited from UIElement.)
Public propertyRenderTransformOrigin
Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.
(Inherited from UIElement.)
Public propertyRequestedTheme
Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.
(Inherited from FrameworkElement.)
Public propertyResources
Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.
(Inherited from FrameworkElement.)
Public propertyStyle
Gets or sets an instance Style that is applied for this object during layout and rendering.
(Inherited from FrameworkElement.)
Public propertySwitchCameraButtonStyle
Allows to override the camera switch button style
Public propertyTag
Gets or sets an arbitrary object value that can be used to store custom information about this object.
(Inherited from FrameworkElement.)
Public propertyTorchButtonStyle
Allows to override the torch button style
Public propertyTorchButtonVisible
Whether the torch on/off button should be shown in the scan UI.
Public propertyTorchEnabled
For internal use only
Public propertyTransitions
Gets or sets the collection of Transition style elements that apply to a UIElement.
(Inherited from UIElement.)
Public propertyTriggers
Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used.
(Inherited from FrameworkElement.)
Public propertyUseLayoutRounding
Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.
(Inherited from UIElement.)
Public propertyVerticalAlignment
Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.
(Inherited from FrameworkElement.)
Public propertyViewFinderLineWidth
The line width with which the view finder rectangle is drawn.
Public propertyViewFinderSizeLandscape
Set the view finder size in relative coordinate when the picker is in landscape orientation
Public propertyViewFinderSizePortrait
Set the view finder size in relative coordinate when the picker is in portrait.
Public propertyViewFinderVisible
Whether the view finder frame should be shown.
Public propertyvisChangeCamera
Public propertyVisibility
Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.
(Inherited from UIElement.)
Public propertyvisTorchButton
Public propertyWidth
Gets or sets the width of a FrameworkElement.
(Inherited from FrameworkElement.)
Top
Methods
  NameDescription
Public methodAddHandler
Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere.
(Inherited from UIElement.)
Public methodArrange
Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.
(Inherited from UIElement.)
Protected methodArrangeOverride
Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior.
(Inherited from FrameworkElement.)
Public methodCancelDirectManipulations
Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.
(Inherited from UIElement.)
Public methodCapturePointer
Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.
(Inherited from UIElement.)
Public methodClearValue
Clears the local value of a dependency property.
(Inherited from DependencyObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFindName
Retrieves an object that has the specified identifier name.
(Inherited from FrameworkElement.)
Protected methodFindSubElementsForTouchTargeting
Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.
(Inherited from UIElement.)
Public methodGetAnimationBaseValue
Returns any base value established for a dependency property, which would apply in cases where an animation is not active.
(Inherited from DependencyObject.)
Public methodGetBindingExpression
Returns the BindingExpression that represents the binding on the specified property.
(Inherited from FrameworkElement.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property from a DependencyObject.
(Inherited from DependencyObject.)
Protected methodGoToElementStateCore
When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup.
(Inherited from FrameworkElement.)
Public methodInvalidateArrange
Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.
(Inherited from UIElement.)
Public methodInvalidateMeasure
Invalidates the measurement state (layout) for a UIElement.
(Inherited from UIElement.)
Public methodMeasure
Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.
(Inherited from UIElement.)
Protected methodMeasureOverride
Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior.
(Inherited from FrameworkElement.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnApplyTemplate
Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.
(Inherited from FrameworkElement.)
Protected methodOnCreateAutomationPeer
When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.
(Inherited from UIElement.)
Protected methodOnDisconnectVisualChildren
Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property.
(Inherited from UIElement.)
Public methodReadLocalValue
Returns the local value of a dependency property, if a local value is set.
(Inherited from DependencyObject.)
Public methodReleasePointerCapture
Releases pointer captures for capture of one specific pointer by this UIElement.
(Inherited from UIElement.)
Public methodReleasePointerCaptures
Releases all pointer captures held by this element.
(Inherited from UIElement.)
Public methodRemoveHandler
Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.
(Inherited from UIElement.)
Public methodSetBinding
Attaches a binding to a FrameworkElement, using the provided binding object.
(Inherited from FrameworkElement.)
Public methodSetValue
Sets the local value of a dependency property on a DependencyObject.
(Inherited from DependencyObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTransformToVisual
Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.
(Inherited from UIElement.)
Public methodUpdateLayout
Ensures that all positions of child objects of a UIElement are properly updated for layout.
(Inherited from UIElement.)
Top
Events
  NameDescription
Public eventDataContextChanged
Occurs when the value of the FrameworkElement.DataContext property changes.
(Inherited from FrameworkElement.)
Public eventDoubleTapped
Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.
(Inherited from UIElement.)
Public eventDragEnter
Occurs when the input system reports an underlying drag event with this element as the target.
(Inherited from UIElement.)
Public eventDragLeave
Occurs when the input system reports an underlying drag event with this element as the origin.
(Inherited from UIElement.)
Public eventDragOver
Occurs when the input system reports an underlying drag event with this element as the potential drop target.
(Inherited from UIElement.)
Public eventDrop
Occurs when the input system reports an underlying drop event with this element as the drop target.
(Inherited from UIElement.)
Public eventGotFocus
Occurs when a UIElement receives focus.
(Inherited from UIElement.)
Public eventHolding
Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.
(Inherited from UIElement.)
Public eventKeyDown
Occurs when a keyboard key is pressed while the UIElement has focus.
(Inherited from UIElement.)
Public eventKeyUp
Occurs when a keyboard key is released while the UIElement has focus.
(Inherited from UIElement.)
Public eventLayoutUpdated
Occurs when the layout of the visual tree changes.
(Inherited from FrameworkElement.)
Public eventLoaded
Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.
(Inherited from FrameworkElement.)
Public eventLostFocus
Occurs when a UIElement loses focus.
(Inherited from UIElement.)
Public eventManipulationCompleted
Occurs when a manipulation on the UIElement is complete.
(Inherited from UIElement.)
Public eventManipulationDelta
Occurs when the input device changes position during a manipulation.
(Inherited from UIElement.)
Public eventManipulationInertiaStarting
Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.
(Inherited from UIElement.)
Public eventManipulationStarted
Occurs when an input device begins a manipulation on the UIElement.
(Inherited from UIElement.)
Public eventManipulationStarting
Occurs when the manipulation processor is first created.
(Inherited from UIElement.)
Public eventPointerCanceled
Occurs when a pointer that made contact abnormally loses contact.
(Inherited from UIElement.)
Public eventPointerCaptureLost
Occurs when pointer capture previously held by this element moves to another element or elsewhere.
(Inherited from UIElement.)
Public eventPointerEntered
Occurs when a pointer enters the hit test area of this element.
(Inherited from UIElement.)
Public eventPointerExited
Occurs when a pointer leaves the hit test area of this element.
(Inherited from UIElement.)
Public eventPointerMoved
Occurs when a pointer moves while the pointer remains within the hit test area of this element.
(Inherited from UIElement.)
Public eventPointerPressed
Occurs when the pointer device initiates a Press action within this element.
(Inherited from UIElement.)
Public eventPointerReleased
Occurs when the pointer device that previously initiated a Press action is released, while within this element.
(Inherited from UIElement.)
Public eventPointerWheelChanged
Occurs when the delta value of a pointer wheel changes.
(Inherited from UIElement.)
Public eventPropertyChanged
Property changed handler
Public eventRightTapped
Occurs when a right-tap input stimulus happens while the pointer is over the element.
(Inherited from UIElement.)
Public eventSizeChanged
Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.
(Inherited from FrameworkElement.)
Public eventTapped
Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.
(Inherited from UIElement.)
Public eventUnloaded
Occurs when this object is no longer connected to the main object tree.
(Inherited from FrameworkElement.)
Top
Fields
  NameDescription
Public fieldStatic memberCameraSwitchVisibilityProperty
Dependency property for the CameraSwitchVisibility
Public fieldStatic memberLaserColorProperty
Dependency property for the LaserColorProperty
Public fieldStatic memberSwitchCameraButtonStyleProperty
Dependency property for the SwitchCameraButtonStyle
Public fieldStatic memberTorchButtonStyleProperty
Dependency property for the TorchButtonStyle
Top
Remarks
The scan overlay is responsible for displaying the scan UI, e.g. the view finder as well as the highlighted barcodes. The scan overlay provides a variety of options to configure the look and feel of the UI.
Version Information

Scandit.Recognition

Supported in: 1.0.0.0
See Also