Note

This API is still in beta and may change in future versions of Scandit Data Capture SDK.

Text Definition

Defined in library scandit_datacapture_barcode

TextDefinition
class TextDefinition : ScanComponentDefinition

Added in version 8.1.0

A class that holds the definition for a text expected to be scanned as part of a certain ScanItemDefinition.

TextDefinition(identifier)
 TextDefinition(TextIdentifier identifier)

Added in version 8.1.0

A constructor that receives the identifier for the text definition.

identifier
TextIdentifier get identifier

Added in version 8.1.0

The unique identifier for this component.

location
Quadrilateral? location

Added in version 8.1.0

The expected location of the text.

optional
bool optional

Added in version 8.1.0

Whether the text is optional.

semantics
ScanComponentTextSemanticType? semantics

Added in version 8.1.0

A semantic type to be applied to the text definition.

hiddenProperties
String hiddenProperties

Added in version 8.1.0

A list of hidden properties to set on the text definition.

valueRegexes
List<String> valueRegexes

Added in version 8.1.0

A list of value regex to use when searching for the text.

anchorRegexes
List<String> anchorRegexes

Added in version 8.1.0

A list of anchor regexes to use when searching for the text.

builder(identifier)
static TextDefinitionBuilder builder(TextIdentifier identifier)

Added in version 8.1.0

Creates a builder object that can be used to fluently create a TextDefinition instance.