MRZScannerConfig

MRZScannerConfig is the class that defines the configurations for MRZ scanning. It is passed to MRZScanner.Start() to configure the scanner before launching.

Definition

Assembly: Dynamsoft.MRZScannerBundle.Maui

Namespace: Dynamsoft.MRZScannerBundle.Maui

class MRZScannerConfig

Properties

Property	Type	Description
`License`	string	Sets or returns the license string.
`TemplateFile`	string?	Sets or returns the template with a file path or a JSON string.
`DocumentType`	EnumDocumentType	Sets or returns the document type to scan, such as ID cards or passports.
`IsTorchButtonVisible`	bool	Sets or returns the visibility of the torch button.
`IsBeepEnabled`	bool	Sets or returns whether the beep sound is enabled when a MRZ is scanned.
`IsVibrateEnabled`	bool	Sets or returns whether the vibration is enabled when a MRZ is scanned.
`IsCloseButtonVisible`	bool	Sets or returns the visibility of the close button.
`IsGuideFrameVisible`	bool	Sets or returns the visibility of the guide frame on the display.
`IsCameraToggleButtonVisible`	bool	Sets or returns the visibility of the camera toggle button.
`IsBeepButtonVisible`	bool	Sets or returns the visibility of the beep toggle button.
`IsVibrateButtonVisible`	bool	Sets or returns the visibility of the vibrate toggle button.
`IsFormatSelectorVisible`	bool	Sets or returns the visibility of the document format selector.
`ReturnDocumentImage`	bool	Sets or returns whether to return a cropped document image in the scan result.
`ReturnPortraitImage`	bool	Sets or returns whether to return a cropped portrait image in the scan result.
`ReturnOriginalImage`	bool	Sets or returns whether to return the original full-frame image in the scan result.

License

Sets or returns the license string.

string License { get; set; }

TemplateFile

Sets or returns the template with a file path or a JSON string.

string? TemplateFile { get; set; }

DocumentType

Sets or returns the document type to scan, such as ID cards or passports.

EnumDocumentType DocumentType { get; set; }

IsTorchButtonVisible

Sets or returns the visibility of the torch button. Users can tap the torch button to turn on or off the torch.

bool IsTorchButtonVisible { get; set; }

IsBeepEnabled

Sets or returns whether the beep sound is enabled when a MRZ is scanned.

bool IsBeepEnabled { get; set; }

IsVibrateEnabled

Sets or returns whether the vibration is enabled when a MRZ is scanned.

bool IsVibrateEnabled { get; set; }

IsCloseButtonVisible

Sets or returns the visibility of the close button.

bool IsCloseButtonVisible { get; set; }

IsGuideFrameVisible

Sets or returns the visibility of the guide frame on the display.

bool IsGuideFrameVisible { get; set; }

IsCameraToggleButtonVisible

Sets or returns the visibility of the camera toggle button that allows users to switch between the rear and front cameras.

bool IsCameraToggleButtonVisible { get; set; }

IsBeepButtonVisible

Sets or returns the visibility of the beep toggle button. Users can tap the beep button to turn on or off the beep sound.

bool IsBeepButtonVisible { get; set; }

IsVibrateButtonVisible

Sets or returns the visibility of the vibrate toggle button. Users can tap the vibrate button to turn on or off vibration feedback.

bool IsVibrateButtonVisible { get; set; }

IsFormatSelectorVisible

Sets or returns the visibility of the document format selector that allows users to switch between scanning modes (ID cards, passports, or both).

bool IsFormatSelectorVisible { get; set; }

ReturnDocumentImage

Sets or returns whether to return a cropped document image in the scan result. Enabled by default.

bool ReturnDocumentImage { get; set; }

ReturnPortraitImage

Sets or returns whether to return a cropped portrait image in the scan result. Enabled by default.

bool ReturnPortraitImage { get; set; }

ReturnOriginalImage

Sets or returns whether to return the original full-frame image in the scan result. Disabled by default.

bool ReturnOriginalImage { get; set; }