Label Capture Validation Flow Settings

Defined in namespace Scandit.DataCapture.Label.UI.Overlay.Validation

LabelCaptureValidationFlowSettings

class LabelCaptureValidationFlowSettings : IDisposable

Added in version 8.2.0

Create()

static LabelCaptureValidationFlowSettings Create()

Added in version 8.2.0

Create a Label Capture Validation Flow Settings object with default values.

MissingFieldsHintText

string MissingFieldsHintText { get;set; }

Added in version 8.2.0

Deprecated since version 8.2: This property is deprecated and will be removed in a future release.

The text in the hint that is shown to the user when an attempt is made to validate a label while there are still empty fields where LabelField.Required is true.

Defaults to “Please fill in missing fields”.

StandbyHintText

string StandbyHintText { get;set; }

Added in version 8.2.0

The text in the hint that is shown to the user when more than 10 seconds have passed during a scanning phase with no scan made, and the flow is paused until further user interaction.

Defaults to “Scanning paused to conserve battery”.

ValidationHintText

string ValidationHintText { get;set; }

Added in version 8.2.0

The text in the hint that is shown to the user when a scanning phase has finished. It informs them of how many fields have been successfully scanned so far

Defaults to “X/Y label fields captured”, where X and Y are the number of captured and expected fields respectively.

ValidationErrorText

string ValidationErrorText { get;set; }

Added in version 8.2.0

The text shown below a field that holds an invalid value. This may happen due to either a bad scan or an incorrect manual input.

Defaults to “Invalid input”.

RequiredFieldErrorText

string RequiredFieldErrorText { get;set; }

Added in version 8.2.0

Deprecated since version 8.2: This property is deprecated and will be removed in a future release.

The text shown below an empty, required field when an attempt to finalize the validation flow has been made.

Defaults to “This field is required”.

FinishButtonText

string FinishButtonText { get;set; }

Added in version 8.2.0

The text shown in the finish button that allows the user to complete the validation flow when all required fields are filled.

Defaults to “Finish”.

RestartButtonText

string RestartButtonText { get;set; }

Added in version 8.2.0

The text shown in the restart button that allows the user to clear all fields and restart the validation flow.

Defaults to “Clear All”.

PauseButtonText

string PauseButtonText { get;set; }

Added in version 8.2.0

The text shown in the pause button that allows the user to pause the scanning process during the validation flow.

Defaults to “Pause”.

ScanningText

string ScanningText { get;set; }

Added in version 8.2.0

The text shown as a placeholder in text fields during the active scanning phase.

Defaults to “Scanning”.

AdaptiveScanningText

string AdaptiveScanningText { get;set; }

Added in version 8.2.0

The text shown as a placeholder in text fields when adaptive scanning is active.

Defaults to “Processing, tap to type manually”.

ManualInputButtonText

string ManualInputButtonText { get;set; }

Added in version 8.2.0

Deprecated since version 8.2: This property is deprecated and no longer used.

The text shown in the button that allows the user to start the flow by inputting values manually for the label fields.

Defaults to “Input Manually”.

SetPlaceholderText()

void SetPlaceholderText(string placeholder, string fieldName)

Added in version 8.2.0

Sets the placeholder text for a specific label definition field.

GetPlaceholderText()

string GetPlaceholderText(string fieldName)

Added in version 8.2.0

Gets the placeholder text for a specific label definition field.