GoodRead Class

The class configures various types of notifications that are triggered upon a successful read. It includes options for enabling or disabling different notification methods, such as LED indicators, vibration, and an overlay on the screen.

Inheritance Hierarchy

System.Object

Com.Datalogic.Decode.Configuration.GoodRead

Namespace: Com.Datalogic.Decode.Configuration
Assembly: datalogic-xamarin-sdk (in datalogic-xamarin-sdk.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Copy

public class GoodRead : PropertyGroup

Public Class GoodRead
	Inherits PropertyGroup

The GoodRead type exposes the following members.

Constructors

	Name	Description
	GoodRead	Initializes a new instance of the GoodRead class
	GoodRead	Initializes a new instance of the GoodRead class

Top

Properties

	Name	Description
	GoodReadEnable	`goodReadEnable` requires the use of the good read notification on a successful read.
	GoodReadLedEnable	`goodReadLedEnable` requires the use of the led notification on a successful read.
	GoodReadOverlayBlackAsTransparent	`goodReadOverlayBlackAsTransparent` selects whether the black or white color in the overlay should be treated as transparent.
	GoodReadOverlayColor	`goodReadOverlayColor` selects which color to use on the overlay as notification on a successful read.
	GoodReadOverlayCustomShapeNameProfile	`goodReadOverlayCustomShapeNameProfile` selects which custom shape to use on the overlay as notification on a successful read.
	GoodReadOverlayEnable	`goodReadOverlayEnable` requires the use of an overlay as notification on a successful read.
	GoodReadOverlayLandscapeCustomPositionX	`goodReadOverlayLandscapeCustomPositionX` selects which custom position for the starting X coordinate (starting from the left) to use for the overlay in landscape mode.
	GoodReadOverlayLandscapeCustomPositionY	`goodReadOverlayLandscapeCustomPositionY` selects which custom position for the starting Y coordinate (starting from the top) to use for the overlay in landscape mode.
	GoodReadOverlayLandscapeCustomSizeMaxHeight	`goodReadOverlayLandscapeCustomSizeMaxHeight` selects which custom height for the overlay to use in landscape mode.
	GoodReadOverlayLandscapeCustomSizeMaxWidth	`goodReadOverlayLandscapeCustomSizeMaxWidth` selects which custom width for the overlay to use in landscape mode.
	GoodReadOverlayLandscapeDisplayPolicy	`goodReadOverlayLandscapeDisplayPolicy` selects which node to use for the overlay in landscape mode.
	GoodReadOverlayLandscapePositionPolicy	`goodReadOverlayLandscapePositionPolicy` selects which position to use for the overlay in landscape mode.
	GoodReadOverlayPortraitCustomPositionX	`goodReadOverlayPortraitCustomPositionX` selects which custom position for the starting X coordinate (starting from the left) to use for the overlay in portrait mode.
	GoodReadOverlayPortraitCustomPositionY	`goodReadOverlayPortraitCustomPositionY` selects which custom position for the starting Y coordinate (starting from the top) to use for the overlay in portrait mode.
	GoodReadOverlayPortraitCustomSizeMaxHeight	`goodReadOverlayPortraitCustomSizeMaxHeight` defines the max custom height for the overlay to use in portrait mode.
	GoodReadOverlayPortraitCustomSizeMaxWidth	`goodReadOverlayPortraitCustomSizeMaxWidth` defines the max custom width for the overlay to use in portrait mode.
	GoodReadOverlayPortraitDisplayPolicy	`goodReadOverlayPortraitDisplayPolicy` selects how to display the overlay in portrait mode.
	GoodReadOverlayPortraitPositionPolicy	`goodReadOverlayPortraitPositionPolicy` selects which position to use for the overlay in portrait mode.
	GoodReadOverlayPreserveColors	`goodReadOverlayPreserveColors` selects whether the original colors of the overlay should be preserved.
	GoodReadOverlayShapePolicy	`goodReaderOverlayShapePolicy` selects which shape to use on the overlay as notification on a successful read.
	GoodReadOverlayTransparency	`goodReadOverlayTransparency` selects the level of transparency to be applied to the overlay.
	GoodReadVibrateEnable	`goodReadVibrateEnable` requires the use of the vibrator notification on a successful read.
	GreenSpotEnable	`greenSpotEnable` requires the use of the green spot notification on a successful read.
	JniPeerMembers	To be added.
	ThresholdClass	To be added.
	ThresholdType	To be added.

Top

Remarks

The GoodRead class configures various types of notifications that are triggered upon a successful read. It includes options for enabling or disabling different notification methods, such as LED indicators, vibration, and an overlay on the screen.

The class provides properties for customizing each type of notification, allowing developers to fine-tune the user experience based on their specific requirements.

The GoodRead class also includes an advanced notification mechanism called the "Good Read Overlay". This overlay appears on the screen upon a successful read and can be customized in terms of color, shape, size, and position. The overlay is adaptable to both portrait and landscape modes, allowing for flexible configuration based on the device's orientation. The portrait and landscape properties are not mutually exclusive; both sets of properties should be configured. Depending on the device's orientation, the appropriate properties will be applied (portrait settings for portrait mode and landscape settings for landscape mode). The class GoodReadOverlayManager provides methods to manage custom images to be used as overlay.

[Android Documentation]