Custom Text
Defined under the namespace Scandit.Datacapture.Label
- CustomText
class CustomText : TextField
Added in version 7.2.0
Defines a text field with customizable OCR recognition and validation patterns. This field type uses optical character recognition (OCR) to extract text content from labels and can apply regex patterns for content validation.
Use the builder pattern with CustomTextBuilder for convenient configuration, or create instances directly using the various factory methods.
- name
get name(): string
Added in version 7.2.0
The unique identifier for this text field within the label definition. This name is used to reference the field when processing captured results and must be unique within the label definition.
- patterns
get patterns(): string[]
Added in version 7.2.0
Regular expression patterns used to validate the recognized text content. These patterns allow you to ensure that the captured text matches the expected format for your specific use case.
For example, you can use patterns like [“\d{2}/\d{2}/\d{4}”] for date formats, or [“[A-Z]{2}\d{6}”] for codes that must start with two letters followed by six digits.
- isOptional
get isOptional(): boolean
Added in version 7.2.0
Determines whether this field is required for the label to be considered complete. When set to true, the label can be marked as complete even if this field is not found. When false (mandatory), the label will only be complete when this field is successfully captured.
Optional fields are useful for scenarios where certain information might not always be present on labels, such as promotional text or secondary identifiers.
- location
get location(): LabelFieldLocation |
undefinedAdded in version 7.2.0
The spatial location constraint for this text field within the label. This can be used to specify where on the label this field is expected to appear, helping to improve recognition accuracy and speed by focusing the OCR processing area.