Class UserGuidanceStates

Namespace

ScanbotSDK.MAUI.Document

Assembly

ScanbotSDK.Shared.dll

Configure the titles of the user guidance hints for different states.

public class UserGuidanceStates

Inheritance

object

UserGuidanceStates

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

BadAngles

The user guidance text displayed when the document pitch/skew angle is unacceptable. Default is "?cameraUserGuidanceBadAngles"

public string BadAngles { get; set; }

Property Value

string

BadAspectRatio

The user guidance text displayed when a landscape document is detected when the camera is in portrait mode (and vice versa). Default is "?cameraUserGuidanceBadAspectRatio"

public string BadAspectRatio { get; set; }

Property Value

string

CaptureManual

The user guidance text displayed when the document is ready to be captured in 'manual snapping' mode. Default is "?cameraUserGuidanceReadyToCaptureManual"

public string CaptureManual { get; set; }

Property Value

string

Capturing

The user guidance text displayed when the document is being captured and user needs to hold the device still. Default is "?cameraUserGuidanceReadyToCapture"

public string Capturing { get; set; }

Property Value

string

EnergySaveMode

The user guidance text displayed when the device is in energy saving mode. iOS only. Default is "?cameraUserGuidanceEnergySaveMode"

public string EnergySaveMode { get; set; }

Property Value

string

NoDocumentFound

The user guidance text displayed when no document is found. Default is "?cameraUserGuidanceNoDocumentFound"

public string NoDocumentFound { get; set; }

Property Value

string

ReadyToCapture

The user guidance text displayed when the document is ready to be captured in 'auto snapping' mode. Default is "?cameraUserGuidanceReadyToCapture"

public string ReadyToCapture { get; set; }

Property Value

string

TextHintOffCenter

The user guidance text displayed when the document is not centered in the finder view. Default is "?cameraUserGuidanceTextHintOffCenter"

public string TextHintOffCenter { get; set; }

Property Value

string

TooDark

The user guidance text displayed when it is too dark to capture an adequate image. Default is "?cameraUserGuidanceTooDark"

public string TooDark { get; set; }

Property Value

string

TooNoisy

The user guidance text displayed when the background is too noisy. Default is "?cameraUserGuidanceTooNoisy"

public string TooNoisy { get; set; }

Property Value

string

TooSmall

The user guidance text displayed when the document is too far from camera. Default is "?cameraUserGuidanceTooSmall"

public string TooSmall { get; set; }

Property Value

string

Methods

FromJson(string)

public static UserGuidanceStates FromJson(string rawJson)

Parameters

rawJson string

Returns

UserGuidanceStates