SparkScan Toast Settings

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

SparkScanToastSettings

class SparkScanToastSettings

Added in version 6.1.0

SparkScanToastSettings()

SparkScanToastSettings(bool toastEnabled, int toastBackgroundColor, int toastTextColor, string targetModeEnabledMessage, string targetModeDisabledMessage, string continuousModeEnabledMessage, string continuousModeDisabledMessage, string cameraTimeoutMessage, string scanPausedMessage, string zoomedInMessage, string zoomedOutMessage, string torchEnabledMessage, string torchDisabledMessage, string userFacingCameraEnabledMessage, string worldFacingCameraEnabledMessage)

Added in version 6.18.0

Constructs a new SparkScan toast settings to use when creating an instance of the SparkScanViewSettings.

SparkScanToastSettings()

SparkScanToastSettings()

Added in version 6.18.0

Constructs a new SparkScan toast settings to use when creating an instance of the SparkScanViewSettings.

ToastEnabled

bool ToastEnabled { get;set; }

Added in version 6.18.0

Should toasts be shown or not.

Default is true.

ToastBackgroundColor

int ToastBackgroundColor { get;set; }

Added in version 6.18.0

Background color of the toast. If this property is null, a default color will be used.

Default is null.

ToastTextColor

int ToastTextColor { get;set; }

Added in version 6.18.0

Text color of the toast. If this property is null, a default color will be used.

Default is null.

TargetModeEnabledMessage

string TargetModeEnabledMessage { get;set; }

Added in version 6.18.0

Text of the toast when target mode enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

TargetModeDisabledMessage

string TargetModeDisabledMessage { get;set; }

Added in version 6.18.0

Text of the toast when target mode disabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

ContinuousModeEnabledMessage

string ContinuousModeEnabledMessage { get;set; }

Added in version 6.18.0

Text of the toast when SparkScanScanningBehavior.Continuous capturing mode enabled.

Default is null. If this property is null, a default message will be shown.

If this property is an empty string, the toast will not be shown.

ContinuousModeDisabledMessage

string ContinuousModeDisabledMessage { get;set; }

Added in version 6.18.0

Text of the toast when SparkScanScanningBehavior.Continuous capturing mode disabled.

Default is null. If this property is null, a default message will be shown.

If this property is an empty string, the toast will not be shown.

CameraTimeoutMessage

string CameraTimeoutMessage { get;set; }

Added in version 6.18.0

Text of the toast when mini preview is hidden due to a timeout to save battery.

Default is null. If this property is null, a default message will be shown.

If this property is an empty string, the toast will not be shown.

Deprecated since version 6.23: This toast is not displayed anymore due to changes in the SparkScan toast system.

ScanPausedMessage

string ScanPausedMessage { get;set; }

Added in version 6.23.0

Text of the toast when SparkScanPreviewBehavior.Persistent capturing mode is enabled and scanning is paused.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

ZoomedInMessage

string ZoomedInMessage { get;set; }

Added in version 6.23.0

Text of the toast when zooming in.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

ZoomedOutMessage

string ZoomedOutMessage { get;set; }

Added in version 6.23.0

Text of the toast when zooming out.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

TorchEnabledMessage

string TorchEnabledMessage { get;set; }

Added in version 6.23.0

Text of the toast when torch is enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

TorchDisabledMessage

string TorchDisabledMessage { get;set; }

Added in version 6.23.0

Text of the toast when torch is disabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

UserFacingCameraEnabledMessage

string UserFacingCameraEnabledMessage { get;set; }

Added in version 6.24.0

Text of the toast when user facing camera is enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.

WorldFacingCameraEnabledMessage

string WorldFacingCameraEnabledMessage { get;set; }

Added in version 6.24.0

Text of the toast when world facing camera is enabled.

Default is null. If this property is null, a default message will be shown. If this property is an empty string, the toast will not be shown.