Zum Hauptinhalt springen
Bietet schreibgeschützten Zugriff auf ein Feld, seinen Wert und seine Parameter.

Eigenschaften

NameTypZugriffsebeneBeschreibung
ChildrenField[]SchreibgeschütztDas Array untergeordneter Felder. Diese Eigenschaft ist nur für Container mit wiederholbaren Feldern gültig.
DataTypeDataTypeSchreibgeschütztDer Datentyp des Felds.
FieldTypeFieldTypeSchreibgeschütztDer Feldtyp.
FullNamestringSchreibgeschütztDer vollständige Pfad zum Namen ab dem Dokumentstamm. Verwendet einen Schrägstrich (/) als Trennzeichen, z. B. Vendor/Address/Street.
HasRegionboolSchreibgeschütztGibt true zurück, wenn das Feld im Dokument gefunden wurde, d. h. wenn im Dokument eine entsprechende Region vorhanden ist. Ein Wert von false gibt an, dass das Dokumentbild keine Region enthält, die diesem Feld entspricht.
IdstringSchreibgeschütztDie Feld-ID aus der Dokumentdefinition.
ImageRegionsImageRegionListSchreibgeschütztEin 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.
IsConfirmedboolSchreibgeschütztGibt 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 unzuverlässig 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 (die Eigenschaft Text) erfolgreich in den Wert des erforderlichen Typs (die 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 eines Felds im Textformat bilden.
TextstringSchreibgeschütztDer ursprüngliche Wert eines Felds im Textformat (bei der Dokumenterkennung generiert).
ValueobjectSchreibgeschütztDer Wert eines Felds im angegebenen Format (bei der Konvertierung des erkannten Texts generiert).

Methoden

NameBeschreibung
Field GetChild(string fieldDefinitionId);Gibt ein untergeordnetes Feld mit der angegebenen ID zurück.