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 Zugriff auf ein Dokumentfeld — seinen Wert, seine Parameter und seine Struktur. In einem Skript können Sie den Wert eines Felds ändern oder vorgeschlagene Werte hinzufügen, die den Bearbeitern in der Manuellen Überprüfung angezeigt werden.

​
Eigenschaften

​
Children

Type: Field[] — Access: Schreibgeschützt Das Array der untergeordneten Felder. Nur für Gruppenfelder gültig.

​
DataType

Typ: DataType — Zugriff: Schreibgeschützt Der Datentyp des Felds.

​
FieldType

Typ: FieldType — Zugriff: Schreibgeschützt Der Feldtyp — zum Beispiel Text, Häkchen oder eine Tabelle (deren Zellen andere Felder darstellen).

​
FullName

Type: string — Zugriff: Schreibgeschützt Der vollständige Pfad zum Feld ausgehend von der Dokumentwurzel. Als Trennzeichen wird ein Schrägstrich (/) verwendet — zum Beispiel Vendor/Address/Street.

​
HasRegion

Type: bool — Zugriff: Lese-/Schreibzugriff true, wenn das Feld im Dokument gefunden wurde (dafür existiert eine Region im Bild). false bedeutet, dass keine entsprechende Region gefunden wurde.

​
HasSuspiciousSymbols

Type: bool — Access: Schreibgeschützt true, wenn der Feldwert Zeichen enthält, die mit niedrigem Konfidenzwert erkannt wurden.

​
Id

Type: string — Zugriff: Schreibgeschützt Die Feldkennung, eindeutig innerhalb des Dokuments.

​
ImageRegions

Type: ImageRegionList — Zugriff: Lese-/Schreibzugriff Ein Array von Feldregionen im Bild.

​
InstanceIndex

Type: int — Zugriff: Schreibgeschützt Der Index der aktuellen Instanz eines Wiederholungsfelds. Für nicht wiederholbare Felder auf -1 gesetzt.

​
Instances

Typ: Field[] — Zugriff: Schreibgeschützt Das Array aller Instanzen dieses Felds (nur Wiederholungsfelder). Verwenden Sie Instances, um auf Instanzen von Wiederholungsfeldern in einem Container zuzugreifen, der über GetField abgerufen wurde.

​
IsConfirmed

Type: bool — Zugriff: Lese-/Schreibzugriff true, wenn das Feld von einem Operator oder durch eine Validierungsregel verifiziert wurde.

​
IsRepeatable

Type: bool — Access: Schreibgeschützt true, wenn das Feld ein Wiederholungsfeld ist.

​
IsSuspicious

Typ: bool — Zugriff: Schreibgeschützt true, wenn Zeichen im Feldwert mit niedrigem Konfidenzwert erkannt wurden. Solche Felder sollten manuell überprüft oder durch eine Regel geprüft werden.

​
IsValid

Typ: bool — Zugriff: Schreibgeschützt true, wenn der erkannte Text in Text erfolgreich in einen Wert des in Value angegebenen Typs konvertiert wurde.

​
IsVisible

Type: bool — Zugriff: Schreibgeschützt true, wenn das Feld im Dokument sichtbar ist.

​
Name

Type: string — Access: Schreibgeschützt Der Feldname, eindeutig innerhalb seiner Gruppe.

​
Parent

Typ: Field — Zugriff: Schreibgeschützt Das übergeordnete Feld.

​
ReadOnly

Type: bool — Zugriff: Schreibgeschützt true, wenn das Feld schreibgeschützt ist und während der Manuellen Überprüfung nicht bearbeitet werden kann.

​
Symbols

Typ: Symbol[] — Zugriff: Schreibgeschützt Ein Array von Zeichen, die den ursprünglichen Wert des Felds im Textformat bilden.

​
Text

Typ: string — Zugriff: Schreibgeschützt Der ursprüngliche Wert des Felds im Textformat (wird bei der Dokumenterkennung generiert).

​
Value

Type: object — Zugriff: Lese-/Schreibzugriff Der Wert des Felds im angegebenen Format (wird beim Konvertieren des erkannten Texts generiert).
Anders als Text speichert die Eigenschaft Value den normalisierten Wert. Wenn ein Skript Value einen anderen normalisierten Wert zuweist, wird Text mit der neuen normalisierten Form aktualisiert. Wenn Value nach der Ausführung des Skripts unverändert bleibt, wird Text nicht aktualisiert.

​
Methoden

​
AddSuggestion

void AddSuggestion(string value);
Fügt dem Feld einen vorgeschlagenen Wert hinzu. Während der manuellen Überprüfung können Bearbeiter aus der Liste vorgeschlagener Werte auswählen.
Wird für Feldgruppen oder Wiederholungsfeld-Container nicht unterstützt.

​
CopyTo

void CopyTo(Field field);
Kopiert Text, Value, ImageRegions und Symbols aus dem als Argument übergebenen Feld in das aktuelle Feld. Gibt einen Fehler zurück, wenn die beiden Felder unterschiedliche Datentypen haben.

​
GetChild

Field GetChild(string fieldName);
Gibt das untergeordnete Feld mit dem angegebenen Namen zurück. Verwenden Sie GetChild, um auf Elemente innerhalb einer Liste zuzugreifen — zum Beispiel auf verschiedene Zellen in derselben Zeile.
Übergeben Sie den Feldnamen als string-Literal, nicht als Variable. Der Skript-Präprozessor ersetzt den Literalnamen vor der Ausführung durch den Bezeichner des Felds — Variablen werden nicht verarbeitet.

Objektmodell

Vollständige JavaScript-Objektreferenz zur Verwendung in erweiterten Skriptregeln.

Context

Das globale Objekt Context — greifen Sie innerhalb einer Regel auf das Dokument, die Felder und Skill-Parameter zu.

FieldType

Aufzählung der verfügbaren Feldtypen und der jeweils unterstützten Datentypen.

DataType

Aufzählung der Datentypen, die ein Feld enthalten kann (einschließlich AmountOfMoney für Währungswerte).