Field - ABBYY Documentation

Field bietet in einem Skript für eine Benutzerdefinierte Aktivität Zugriff auf den Wert, den Typ, die Struktur und die OCR-Metadaten eines Dokumentfelds.

Eigenschaften

Name	Type	Access	Description
Children	Field[]	Schreibgeschützt	Untergeordnete Felder.
DataType	DataType	Schreibgeschützt	Der Datentyp des Felds.
FieldType	FieldOcrType	Schreibgeschützt	Der Feldtyp (zum Beispiel Text, Barcode oder Bild).
FullName	string	Schreibgeschützt	Der vollständige Pfad ab der Dokumentwurzel. Die Namen übergeordneter Felder sind durch `/` getrennt, zum Beispiel `Vendor/Address`.
Id	string	Schreibgeschützt	Die Kennung einer Felddefinition aus der Dokumentdefinition.
InstanceId	string	Schreibgeschützt	Die Kennung einer Feldinstanz. Wenn das Dokument keine Instanzen des Felds hat, ist `InstanceId` `null`.
InstanceIndex	number	Schreibgeschützt	Der Index der aktuellen Instanz unter allen Wiederholungsfeldern desselben Typs. Nur für Wiederholungsfelder relevant.
Instances	Field[]	Schreibgeschützt	Alle Instanzen dieses Felds. Nur für Wiederholungsfelder relevant.
IsConfirmed	boolean	Schreibgeschützt	`true`, wenn der Wert während der Verifizierung von einem Operator bestätigt wurde.
IsRepeatable	boolean	Schreibgeschützt	`true`, wenn das Feld wiederholbar ist.
IsSuspicious	boolean	Schreibgeschützt	`true`, wenn die Erkennung für dieses Feld unsicher war.
IsValid	boolean	Schreibgeschützt	`true`, wenn `Text` erfolgreich in einen `Value` des richtigen Typs konvertiert wurde; andernfalls `false`.
IsVisible	boolean	Schreibgeschützt	`true`, wenn das Feld für Operatoren sichtbar ist; `false`, wenn es während der Verifizierung ausgeblendet ist.
Name	string	Schreibgeschützt	Der Feldname.
Parent	Field	Schreibgeschützt	Das übergeordnete Feld.
Regions	RegionsCollection	Schreibgeschützt	Die Regionen im Bild, in denen sich das Feld befindet.
Text	string	Schreibgeschützt	Der im Dokument erkannte Feldtext.
Value	object	Lese-/Schreibzugriff	Der Feldwert, konvertiert in den entsprechenden Datentyp (zum Beispiel Datum oder Gleitkommazahl).
Image	BinaryFile	Schreibgeschützt	Das Bild im Binärformat.

Image gilt nur für Felder vom Typ Picture.

Methoden

AddInstance

Field AddInstance(any value?);

Erstellt oder aktualisiert eine Feldinstanz, je nach Feldtyp:

Nicht wiederholbare Felder — Aktualisiert die vorhandene Instanz bzw. erstellt eine, wenn noch keine existiert.
Wiederholungsfelder — Erstellt eine neue Instanz.

Gibt das erstellte oder aktualisierte Field-Objekt zurück.

Remove

void Remove();

Löscht das Feld.