Zum Hauptinhalt springen
Bietet Zugriff auf ein Feld, seinen Wert und Parameter. Der Wert eines Felds kann mithilfe eines Skripts geändert werden. Skripte können außerdem verwendet werden, um vorgeschlagene Werte hinzuzufügen, die den Prüfern in der Manuellen Überprüfung angezeigt werden.

​
Eigenschaften

NameTypZugriffsebeneBeschreibung
ChildrenField[]SchreibgeschütztDas Array der untergeordneten Felder. Diese Eigenschaft ist nur für Gruppenfelder gültig.
DataTypeDataTypeSchreibgeschütztDer Datentyp des Felds.
FieldTypeFieldTypeSchreibgeschütztDer Feldtyp, zum Beispiel Text, Auswahlkästchen oder eine Tabelle (enthält Zellen, die andere Felder darstellen).
FullNamestringSchreibgeschütztDer vollständige Pfad zum Namen ab der Document-Root. Verwendet einen Schrägstrich (/) als Trennzeichen, z. B. Vendor/Address/Street.
HasRegionboolLese-/SchreibzugriffGibt true zurück, wenn das Feld im Dokument gefunden wurde, d. h. wenn eine entsprechende Region im Dokument vorhanden ist. Ein Wert von false gibt an, dass das Dokumentbild keine Region enthält, die diesem Feld entspricht.
HasSuspiciousSymbolsboolSchreibgeschütztGibt true zurück, wenn der Feldwert Zeichen enthält, die mit geringer Sicherheit erkannt wurden.
IdstringSchreibgeschütztDie Feldkennung, im Dokument eindeutig.
ImageRegionsImageRegionListLese-/SchreibzugriffEin Array von Feldregionen im Bild.
InstanceIndexintSchreibgeschütztDer Index der aktuellen Instanz des wiederholbaren Felds. Ergibt nur Sinn, wenn IsRepeatable true ist. In allen anderen Fällen auf -1 gesetzt.
InstancesField[]SchreibgeschütztDas Array aller Instanzen dieses Felds. Ergibt nur Sinn, wenn IsRepeatable true ist. Die Eigenschaft Instances kann verwendet werden, um auf Instanzen eines wiederholbaren Felds in einem Container zuzugreifen, der mit der Methode Field GetField abgerufen wurde.
IsConfirmedboolLese-/SchreibzugriffGibt true zurück, wenn das Feld vom Operator oder durch eine Validierungsregel bestätigt wurde.
IsRepeatableboolSchreibgeschütztGibt true zurück, wenn das Feld wiederholbar ist.
IsSuspiciousboolSchreibgeschütztGibt true zurück, wenn Zeichen des Feldwerts mit geringer Sicherheit erkannt wurden. Der Wert eines solchen Felds sollte entweder vom Operator manuell überprüft oder durch eine Regel geprüft werden.
IsValidboolSchreibgeschütztGibt true zurück, wenn der erkannte Text des Felds – gespeichert in der Eigenschaft Text – erfolgreich in den Wert des angegebenen Typs in der Eigenschaft Value konvertiert wurde.
IsVisibleboolSchreibgeschütztGibt true zurück, wenn das Feld im Dokument sichtbar ist.
NamestringSchreibgeschütztDer Feldname, innerhalb seiner Gruppe eindeutig.
ParentFieldSchreibgeschütztDas übergeordnete Feld.
ReadOnlyboolSchreibgeschütztGibt true zurück, wenn das Feld nur lesbar ist und vom Operator der Manuellen Überprüfung nicht bearbeitet werden darf.
SymbolsSymbol[]SchreibgeschütztEin Array von Zeichen, die den ursprünglichen Wert des Felds im Textformat bilden.
TextstringSchreibgeschütztDer ursprüngliche Wert des Felds im Textformat (wird bei der Erkennung eines Dokuments erzeugt).
ValueobjectLese-/SchreibzugriffDer Wert des Felds im angegebenen Format (wird bei der Konvertierung des erkannten Texts erzeugt). Hinweis: Anders als die Eigenschaft Text speichert die Eigenschaft Value Werte in einem normalisierten Format. Wenn der normalisierte Wert der Eigenschaft Value infolge der Ausführung eines Skripts geändert wird, wird der Wert der Eigenschaft Text mit dem neuen normalisierten Wert aktualisiert. Bleibt der normalisierte Wert der Eigenschaft Value nach der Skriptausführung unverändert, wird der Wert der Eigenschaft Text nicht aktualisiert.

​
Methoden

NameBeschreibung
void AddSuggestion(string value);Fügt einen vorgeschlagenen Wert für das Feld hinzu. Mit dieser Methode kann der Benutzer den Wert aus der Liste der Vorschläge auswählen. Die vorgeschlagenen Werte werden während der manuellen Überprüfung angezeigt. Diese Methode kann nicht auf Feldgruppen und wiederholende Feldcontainer angewendet werden.
void CopyTo(Field field);Kopiert die folgenden Eigenschaften des Argumentfelds in das aktuelle Feld: Text, Value, ImageRegions, Symbols. Wenn Feld- und Felddatentypen nicht identisch sind, gibt die Methode einen Fehler zurück.
Field GetChild(string fieldName);Gibt ein untergeordnetes Feld mit dem angegebenen Namen zurück. Diese Methode erleichtert den Zugriff auf verschiedene Elemente derselben Liste, z. B. unterschiedliche Zellen in derselben Zeile. Wichtig! Übergeben Sie den string-Namen des Felds direkt an diese Methode: Eine Variable mit demselben string-Wert funktioniert nicht. Der Präprozessor, der den Skriptcode vor der Ausführung analysiert, ersetzt den Namen des Felds durch dessen Kennung, kann jedoch eine Variable nicht verarbeiten.