Class TextDataScannerStep

Namespace

ScanbotSDK.MAUI.TextData

Assembly

DocumentSDK.MAUI.dll

public sealed class TextDataScannerStep

Inheritance

object

TextDataScannerStep

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

TextDataScannerStep(string, string, float, AspectRatio?)

Initiates a text data scanner step object with following parameters.

public TextDataScannerStep(string guidanceText, string pattern, float preferredZoom, AspectRatio? aspectRatio)

Parameters

guidanceText string

User guidance hint text.

pattern string

Validation pattern to automatically validate recognized text. '?' = any character, '#' - any digit, all other characters represent themselves. An empty string or nil value will disable the validation pattern.

preferredZoom float

The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

aspectRatio AspectRatio

The aspect ratio of the finder overlay

Exceptions

ArgumentNullException

Thrown if some required parameters are passed as null

Properties

AllowedSymbols

A string (list) of accepted characters during text recognition. If empty or nil, all characters are accepted. Defaults to nil.

public string AllowedSymbols { get; set; }

Property Value

string

AspectRatio

The aspect ratio of the finder overlay

public AspectRatio? AspectRatio { get; set; }

Property Value

AspectRatio

GuidanceText

User guidance hint text.

public string GuidanceText { get; set; }

Property Value

string

Pattern

Validation pattern to automatically validate recognized text. '?' = any character, '#' - any digit, all other characters represent themselves. An empty string or nil value will disable the validation pattern.

public string Pattern { get; set; }

Property Value

string

PreferredZoom

The cameras zoom level preferred for this step. The actual zoom might be different from the preferred one to avoid clipping of finder area and maintain its aspect ratio and height

public float PreferredZoom { get; set; }

Property Value

float

ShouldMatchSubstring

If set to TRUE pattern validation also validates successfully if only a part of the whole recognized text matches the the validation pattern. If set to FALSE, the whole text must match the validation pattern. Applies to pattern validation only. Defaults to FALSE.

public bool? ShouldMatchSubstring { get; set; }

Property Value

bool?

SignificantShakeDelay

Detection will be paused after significant movement, in milliseconds. Default is 1000.

public long? SignificantShakeDelay { get; set; }

Property Value

long?

TextFilterStrategy

Recognition strategy for the text.

public TextFilterStrategy TextFilterStrategy { get; set; }

Property Value

TextFilterStrategy

UnzoomedFinderHeight

The preferred height of the finder for zoom scale 1.0 (unzoomed). The actual finder height might change to maintain aspect ratio and to not clip the screen. Defaults to 40 points.

public float? UnzoomedFinderHeight { get; set; }

Property Value

float?