Class GenericDocumentRecognizerConfiguration

Namespace

ScanbotSDK.MAUI.GenericDocument

Assembly

DocumentSDK.MAUI.dll

public sealed class GenericDocumentRecognizerConfiguration

Inheritance

object

GenericDocumentRecognizerConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AcceptedDocumentTypes

An array of recognizable document types. Please specify at least one document type which you want to scan. Please also check properties in [GenericDocumentFormat]

public GenericDocumentRootType[] AcceptedDocumentTypes { get; set; }

Property Value

GenericDocumentRootType[]

CameraModule

Set supported camera module. Optional.By default is [CameraModule.Back] The enum type [CameraModule.BackWidest] is iOS only, It will be considered [CameraModule.Back] for Android.

public CameraModule? CameraModule { get; set; }

Property Value

CameraModule?

CameraOverlayColor

Background color of the detection overlay.

public Color CameraOverlayColor { get; set; }

Property Value

Color

CameraPreviewMode

Preview mode of the camera: fit-in or fill-in. Optional, default is [CameraPreviewMode.FillIn]

public CameraPreviewMode? CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode?

CancelButtonTitle

String being displayed on the cancel button.

public string CancelButtonTitle { get; set; }

Property Value

string

ClearButtonTitle

String being displayed on the clear button.

public string ClearButtonTitle { get; set; }

Property Value

string

ConfidenceValue

The recognized words confidence value.

public string ConfidenceValue { get; set; }

Property Value

string

DetailsActionColor

Foreground color of the top bar buttons on the details screen.

public Color DetailsActionColor { get; set; }

Property Value

Color

DetailsBackgroundColor

Background color of the details screen.

public Color DetailsBackgroundColor { get; set; }

Property Value

Color

DetailsPrimaryColor

Text color in the details barcodes list. Also affects image background, separator and progress spinner.

public Color DetailsPrimaryColor { get; set; }

Property Value

Color

EnableCameraButtonTitle

String being displayed on the button to request camera access.

public string EnableCameraButtonTitle { get; set; }

Property Value

string

EnableCameraExplanationText

String being displayed on the label describing the camera access requirement.

public string EnableCameraExplanationText { get; set; }

Property Value

string

ExcludedFieldTypes

An array of recognizable document types. Please specify at least one document type which you want to scan.

public List<string> ExcludedFieldTypes { get; set; }

Property Value

List<string>

FieldConfidenceHighColor

Color of confidence value label background in details screen, when the field confidence level is high.

public Color FieldConfidenceHighColor { get; set; }

Property Value

Color

FieldConfidenceLowColor

Color of confidence value label background in details screen, when the field confidence level is low.

public Color FieldConfidenceLowColor { get; set; }

Property Value

Color

FieldConfidenceModerateColor

Color of confidence value label background in details screen, when the field confidence level is moderate.

public Color FieldConfidenceModerateColor { get; set; }

Property Value

Color

FieldConfidenceTextColor

Color of confidence value label text in details

public Color FieldConfidenceTextColor { get; set; }

Property Value

Color

FieldsCountText

Text color of the fields count label.

public string FieldsCountText { get; set; }

Property Value

string

FieldsCountTextColor

Text color of the fields count label.

public Color FieldsCountTextColor { get; set; }

Property Value

Color

FinderLineColor

Foreground color of the detection overlay.

public Color FinderLineColor { get; set; }

Property Value

Color

FinderLineWidth

Width of finder frame border. Default is 2.

public double? FinderLineWidth { get; set; }

Property Value

double?

FlashEnabled

Controls whether the flash should be initially enabled. The default value is FALSE.

public bool? FlashEnabled { get; set; }

Property Value

bool?

ImageTitle

Sets a title to show image content.

public string? ImageTitle { get; set; }

Property Value

string

NoDataTitle

String that notifies that nothing was scanned yet.

public string NoDataTitle { get; set; }

Property Value

string

OrientationLockMode

Allowed orientations for automatic interface rotations. *

public OrientationLockMode? OrientationLockMode { get; set; }

Property Value

OrientationLockMode?

ScanBackSideTitle

String that asks user to scan back side of a card.

public string ScanBackSideTitle { get; set; }

Property Value

string

ScanFrontSideTitle

String that asks user to scan front side of a card.

public string ScanFrontSideTitle { get; set; }

Property Value

string

ScannedEverythingTitle

String that notifies that both sides of card are scanned.

public string ScannedEverythingTitle { get; set; }

Property Value

string

SharpnessAcceptanceFactor

The default value is 80.

public double? SharpnessAcceptanceFactor { get; set; }

Property Value

double?

StartScanningTitle

String that asks user to start scanning a card.

public string StartScanningTitle { get; set; }

Property Value

string

SubmitButtonTitle

String being displayed on the submit button.

public string SubmitButtonTitle { get; set; }

Property Value

string

TipBackgroundColor

Color of tip background on scanning screen.

public Color TipBackgroundColor { get; set; }

Property Value

Color

TipTextColor

Color of tip text on scanning screen.

public Color TipTextColor { get; set; }

Property Value

Color

TopBarBackgroundColor

Background color of the top bar.

public Color TopBarBackgroundColor { get; set; }

Property Value

Color

TopBarButtonsColor

Foreground color of the top bar buttons on the scanning screen.

public Color TopBarButtonsColor { get; set; }

Property Value

Color

TopBarButtonsInactiveColor

Foreground color of disabled items in the top bar.

public Color TopBarButtonsInactiveColor { get; set; }

Property Value

Color

TouchToFocusEnabled

Controls whether the touch to focus feature should be enabled. Default is true.

public bool? TouchToFocusEnabled { get; set; }

Property Value

bool?

UseButtonsAllCaps

Android only: Use buttons in all caps.

public bool? UseButtonsAllCaps { get; set; }

Property Value

bool?