Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

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

NameTypeAccessDescription
ChildrenField[]SchreibgeschütztUntergeordnete Felder.
DataTypeDataTypeSchreibgeschütztDer Datentyp des Felds.
FieldTypeFieldOcrTypeSchreibgeschütztDer Feldtyp (zum Beispiel Text, Barcode oder Bild).
FullNamestringSchreibgeschütztDer vollständige Pfad ab der Dokumentwurzel. Die Namen übergeordneter Felder sind durch / getrennt — zum Beispiel Vendor/Address.
IdstringSchreibgeschütztDie Kennung einer Felddefinition aus der Dokumentdefinition.
InstanceIdstringSchreibgeschütztDie Kennung einer Feldinstanz. Wenn das Dokument keine Instanzen des Felds hat, ist InstanceId null.
InstanceIndexnumberSchreibgeschütztDer Index der aktuellen Instanz unter allen Wiederholungsfeldern desselben Typs. Nur für Wiederholungsfelder relevant.
InstancesField[]SchreibgeschütztAlle Instanzen dieses Felds. Nur für Wiederholungsfelder relevant.
IsConfirmedbooleanSchreibgeschützttrue, wenn der Wert während der Verifizierung von einem Operator bestätigt wurde.
IsRepeatablebooleanSchreibgeschützttrue, wenn das Feld wiederholbar ist.
IsSuspiciousbooleanSchreibgeschützttrue, wenn die Erkennung für dieses Feld unsicher war.
IsValidbooleanSchreibgeschützttrue, wenn Text erfolgreich in einen Value des richtigen Typs konvertiert wurde; andernfalls false.
IsVisiblebooleanSchreibgeschützttrue, wenn das Feld für Operatoren sichtbar ist; false, wenn es während der Verifizierung ausgeblendet ist.
NamestringSchreibgeschütztDer Feldname.
ParentFieldSchreibgeschütztDas übergeordnete Feld.
RegionsRegionsCollectionSchreibgeschütztDie Regionen im Bild, in denen sich das Feld befindet.
TextstringSchreibgeschütztDer im Dokument erkannte Feldtext.
ValueobjectLese-/SchreibzugriffDer Feldwert, konvertiert in den entsprechenden Datentyp (zum Beispiel Datum oder Gleitkommazahl).
ImageBinaryFileSchreibgeschütztDas 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.

Document

Das Dokument, das derzeit von der Benutzerdefinierten Aktivität verarbeitet wird.

DataType

Die möglichen Datentypen, die ein Feld enthalten kann.

FieldOcrType

Gibt den OCR-Typ des extrahierten Felds an.

Region

Bereich in einem Seitenbild, der den Text für ein Feld enthält.

BinaryFile

Dateidaten im Binärformat — in der Regel das Quellbild vor der Vorverarbeitung.

Objektmodell

Vollständige JavaScript-Objektreferenz für Skripte der Benutzerdefinierten Aktivität.