Class TextDataScannerConfiguration

Namespace

ScanbotSDK.MAUI.TextData

Assembly

DocumentSDK.MAUI.dll

public sealed class TextDataScannerConfiguration

Inheritance

object

TextDataScannerConfiguration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TextDataScannerConfiguration(TextDataScannerStep)

public TextDataScannerConfiguration(TextDataScannerStep step)

Parameters

step TextDataScannerStep

Properties

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 outside of the finder window

public Color CameraOverlayColor { get; set; }

Property Value

Color

CameraPreviewMode

Preview mode of the camera. FILL_IN or FIT_IN. Default is FILL_IN. Android only

public CameraPreviewMode? CameraPreviewMode { get; set; }

Property Value

CameraPreviewMode?

CancelButtonTitle

Title of the cancel button.

public string CancelButtonTitle { get; set; }

Property Value

string

EnableCameraButtonTitle

Title of the button that opens the screen where the user can allow the usage of the camera by the app.

public string EnableCameraButtonTitle { get; set; }

Property Value

string

EnableCameraExplanationText

Text that will be displayed when the app is not allowed to use the camera, prompting the user to enable the usage of the camera. */

public string EnableCameraExplanationText { get; set; }

Property Value

string

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?

FinderTextHintColor

Foreground color of the description label.

public Color FinderTextHintColor { get; set; }

Property Value

Color

FlashEnabled

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

public bool? FlashEnabled { get; set; }

Property Value

bool?

MaximumNumberOfAccumulatedFrames

Maximum number of accumulated frames to inspect before actual result is returned

public int? MaximumNumberOfAccumulatedFrames { get; set; }

Property Value

int?

MinimumNumberOfRequiredFramesWithEqualRecognitionResult

Minimum required number of accumulated frames that have equal result

public int? MinimumNumberOfRequiredFramesWithEqualRecognitionResult { get; set; }

Property Value

int?

OcrResolutionLimit

The image will be downscaled to the given value during the processing. If the quality of the scanning is not enough, try to increase the limit. This variable affects the performance of the scanning process. Higher the size limit - better the quality, but the recognition is slower. 0 - do not rescale. */

public int? OcrResolutionLimit { get; set; }

Property Value

int?

OrientationLockMode

UI Interface orientation lock mode

public OrientationLockMode? OrientationLockMode { get; set; }

Property Value

OrientationLockMode?

TextDataScannerStep

Configuration for the scanned item

public TextDataScannerStep TextDataScannerStep { get; set; }

Property Value

TextDataScannerStep

TopBarBackgroundColor

The background color of the top toolbar.

public Color TopBarBackgroundColor { get; set; }

Property Value

Color

TopBarButtonsColor

The color of all active toggle buttons in the toolbar.

public Color TopBarButtonsColor { get; set; }

Property Value

Color

TopBarButtonsInactiveColor

Color of the titles of all buttons in the top toolbar.

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

Controls whether buttons should use all capitals style, as defined by the Android Material Design. Defaults to TRUE. Android only.

public bool? UseButtonsAllCaps { get; set; }

Property Value

bool?

WordBoxHighlightColor

The color of the highlight of the wordboxes founded on the frame

public Color WordBoxHighlightColor { get; set; }

Property Value

Color

WordBoxHighlightEnabled

If the wordboxes should be highlighted when were found on the frame

public bool? WordBoxHighlightEnabled { get; set; }

Property Value

bool?