IField - ABBYY Documentation

Ein Dokumentfeld. Der Typ des Feldes kann anhand der Eigenschaft Type bestimmt werden. Für Tabellenfelder stehen die Objektmethoden Rows und Cell zur Verfügung.

Methoden

Methode	Beschreibung
`AddRegion( page : IPage, rect : string ) : IFieldRegion`	Fügt dem Feld eine Region mit den angegebenen Koordinaten hinzu. `rect` ist die Beschreibung eines Rechtecks im Format `[left,top,right,bottom]`. Diese Methode erfordert Schreibberechtigungen für das `IField`-Objekt. Sie ist für Tabellen nicht verfügbar. Verwenden Sie zum Löschen einer Region die `Delete()`-Methode von IFieldRegion. Ein Beispiel finden Sie unter Eine Feldregion kopieren.
`Cell( columnName : string, rowNum : int ) : IField`	Ruft eine Tabellenzelle anhand des Spaltennamens und der Zeilennummer ab. Nur für Tabellen verfügbar. In Skriptregeln nicht verfügbar.
`CheckRules( )`	Prüft die Regeln für das angegebene Feld und dessen untergeordnete Elemente. Kann nicht in Regeln verwendet werden.
`Field( Path : string ) : IField`	Sucht nach einem untergeordneten Element relativ zum angegebenen Element. Dabei werden relative Pfade verwendet. In Regeln können nur Synonyme von Feldnamen verwendet werden, die in den Regeleinstellungen definiert sind.
`GetFieldExtractor( )`	Gibt ein IFieldExtractor-Objekt zurück.
`GetLangs( ) : IVARIANTArray`	Gibt die IDs der in einem Feld erkannten Sprachen zurück. Ein Beispiel finden Sie unter Die Sprachen in einem Feld prüfen.
`HasField( parameter : string ) : bool`	Prüft, ob ein Feld mit dem angegebenen Pfad vorhanden ist. Dabei werden relative Pfade verwendet. In Regeln können nur Synonyme von Feldnamen verwendet werden, die in den Regeleinstellungen definiert sind.
`Suggest( VARIANT newSuggest )`	Fügt dem Feld einen Vorschlag hinzu. Dieser kann als Wert oder string angegeben werden. Hinzugefügte Werte werden mit vier Dezimalstellen geschrieben. Beispielsweise fügt `field.Suggest( "12.90" )` den Vorschlag als `12.90` hinzu, während `field.Suggest( 12.90 )` ihn als `12.9000` hinzufügt.

Eigenschaften

Name	Typ	Zugriff	Beschreibung
Beschriftung	string	Schreibgeschützt	Der Name des im Formular angezeigten Feldes. Der Wert dieser Eigenschaft kann mit dem der Eigenschaft Name übereinstimmen.
Unterelemente	IFields	Schreibgeschützt	Untergeordnete Elemente des Feldes (bei Tabellen Zellen). In Skriptregeln nicht verfügbar.
FullName	string	Schreibgeschützt	Der vollständige Name eines Felds relativ zum Dokument. Ein eindeutiger Bezeichner des Felds im Dokument. Kann verwendet werden, um mit der Methode Field nach Dokumentfeldern zu suchen. In Skriptregeln entspricht der zurückgegebene Wert Name und ist nicht eindeutig.
HasRuleError	bool	Lesen/Schreiben	Gibt an, ob dem Feld eine Regelwarnung oder ein Fehler zugeordnet ist. In Skriptregeln legt diese Eigenschaft fest, ob das Feld in der Fehlermeldung angezeigt wird. Eine Regel umfasst eine Sammlung von Feldern, die im Dialogfeld Regeleigenschaften angegeben sind. Schlägt die Regelprüfung fehl, zeigt der Dokumenteditor die Fehlermeldung aus IRuleContext `ErrorMessage` an. Zudem werden Links zu den Feldern der Sammlung angezeigt. Wenn diese Eigenschaft auf `false` gesetzt wird, wird das Feld aus der Liste der mit dem Fehler verknüpften Links ausgeschlossen.
IsExportable	bool	Schreibgeschützt	Gibt an, ob das Feld gemäß den Einstellungen der Dokumentdefinition für den Export vorgesehen ist.
IsIndexed	bool	Schreibgeschützt	Gibt an, ob das Feld indexierbar ist. Falls ja, ist der Feldwert über die externen Felder des Dokuments und der Seite in der Dokumentdefinition verfügbar.
IsMatched	bool	Schreibgeschützt	Gibt an, ob das Feld gefunden wurde.
IsSuspicious	bool	Schreibgeschützt	Gibt an, ob der Feldwert zweifelsfrei erkannt wurde.
IsValid	bool	Schreibgeschützt	Gibt an, ob das Feld keine Formatfehler enthält.
IsVerified	bool	Lesen/Schreiben	Gibt an, ob das Feld verifiziert ist. Diese Eigenschaft funktioniert nicht für Feldgruppen. Sie kann in Regeln auch ohne Schreibberechtigungen für das Feld auf `true` gesetzt werden. Zum Aufheben des Flags sind Schreibberechtigungen erforderlich. Wenn das Flag `true` ist, wird das Feld im Dokumenteditor grau angezeigt, als wäre es bereits bestätigt. Wenn das Flag `false` ist, wird das Feld weiß angezeigt und muss bestätigt werden. Nachdem das Feld verifiziert wurde, wird das Flag auf `true` gesetzt. Das Setzen dieses Flags auf `false` leitet das Feld nicht an die Stufe „Data Verification“ weiter. Verwenden Sie hierfür die Eigenschaft `NeedVerification` der Schnittstellen `IField` oder ICharacterParams.
IsVisible	bool	Lesen/Schreiben	Gibt an, ob das Feld im Dokumentlayout gemäß den Einstellungen der Dokumentdefinition angezeigt werden soll.
Elemente	IFields	Schreibgeschützt	Instanzen des Felds (Zeilen in Tabellenfeldern).
Name	string	Schreibgeschützt	Der Feldname in der Dokumentdefinition.
NeedVerification	bool	Lesen/Schreiben	Gibt an, ob das Feld selbst (nicht seine Zeichen) verifiziert werden muss. Wenn das Flag auf `true` gesetzt ist, wird das Feld im Dokumenteditor mit rotem Hintergrund angezeigt, was bedeutet, dass es verifiziert werden muss. Wenn in den Feldeigenschaften die Option Send to field verification ausgewählt ist, wird das Feld an die Stufe Data Verification weitergeleitet. Nachdem das Feld verifiziert wurde, wird das Flag auf `false` gesetzt. Um anzugeben, ob bestimmte Zeichen, nicht aber das gesamte Feld, verifiziert werden müssen, verwenden Sie die Eigenschaft `NeedVerification` der Schnittstelle ICharacterParams.
ReadOnly	bool	Schreibgeschützt	Gibt an, ob das Feld gemäß den Einstellungen der Dokumentdefinition schreibgeschützt ist. Bei Verwendung in Regeln gibt diese Eigenschaft an, dass die Regel Schreibzugriff auf das Feld hat.
ReadOnlyInForm	bool	Lesen/Schreiben	Gibt an, ob das Feld im Formular schreibgeschützt ist (gemäß den Einstellungen der Dokumentdefinition).
Regionen	IFieldRegions	Schreibgeschützt	Ein Array von Feldregionen. Überlaufende Felder können mehrere Regionen aufweisen. Nur verfügbar, wenn in den Lizenz-Eigenschaften die Option Advanced XML Export ausgewählt ist.
Zeilen	IFields	Schreibgeschützt	Eine Sammlung von Tabellenzeilen. Für Felder, die keine Tabellenfelder sind, nicht verfügbar.
Symbole	ICharactersParams	Schreibgeschützt	Detaillierte Informationen zu den Symboleigenschaften.
Text	string	Lesen/Schreiben	Die Textdarstellung eines Feldwerts.
Typ	TExportFieldType	Schreibgeschützt	Der Typ eines Feldes.
Value	VARIANT	Lesen/Schreiben	Der Wert des Felds als VARIANT. Die Eigenschaft gibt ein `Int32`-Objekt zurück, wenn die Feldeinstellungen angeben, dass das Feld eine Ganzzahl enthält, deren absoluter Wert höchstens `2147483647` beträgt. Ist der absolute Wert des Felds größer als `2147483647`, gibt die Eigenschaft ein Objekt vom Typ double zurück.

Eine Feldregion kopieren

Der folgende Code kopiert die Region von Feld 1 nach Feld 2:

field2.AddRegion( field1.Regions[0].Page, field1.Regions[0].SurroundingRect.ToString() )

Überprüfen der Sprachen in einem Feld

Das folgende Benutzerskript prüft, welche Sprachen in einem Feld vorhanden sind:

var t = Context.Field("Field Name").GetLangs();
var p = "";
foreach (var s in t)
{
p += s.ToString()+",";
}
FCTools.ShowMessage( "Language " +  p);