IField

Worum geht es

Ein Dokumentfeld. Der Feldtyp kann über die Eigenschaft Type bestimmt werden. Für Tabellenfelder stehen die Objektmethoden Rows und Cell zur Verfügung.

Methoden

Definition Beschreibung
AddRegion( page : IPage, rect : string ) : IFieldRegion

Fügt dem Feld einen Bereich mit festgelegten Koordinaten hinzu. rect ist die Beschreibung eines als [left,top,right,bottom] formatierten Rechtecks. Diese Methode erfordert Schreibrechte für das IField-Objekt.

Beispielcode

Hinweis. Diese Methode ist für Tabellen nicht verfügbar. Für das Löschen eines Bereichs verwenden Sie die Methode  IFieldRegion.Delete().

Cell( columnName : string, rowNum : int ) : IField Ruft eine Tabellenzelle nach Spaltenname und Zeilennummer ab. Nur für Tabellen verfügbar. Nicht verfügbar in Skriptregeln.
CheckRules( ) Überprüft die Regeln für das vorgegebene Feld und dessen untergeordnete Felder. Kann nicht in Regeln verwendet werden.
Field( Path : string) : IField Suche nach dem untergeordneten Element in Bezug auf das vorgegebene Element. Es werden Relative Pfade verwendet. Nur Synonyme der Feldnamen, wie sie in den Regeleinstellungen definiert wurden, können in Regeln verwendet werden.
HasField( parameter : string) : bool Überprüft, ob das Feld mit dem angegebenen Pfad vorhanden ist. Es werden Relative Pfade verwendet. Nur Synonyme der Feldnamen, wie sie in den Regeleinstellungen definiert wurden, können in Regeln verwendet werden.
Suggest( VARIANT newSuggest )

Fügt dem Feld eine Aufforderung hinzu.  

Hinweis. Das kann in der Form eines Werts oder Zeichenfolge sein. Die hinzugefügten Werte werden mit vier Dezimalstellen geschrieben.

Die Methode field.Suggest( "12.90" ) beispielsweise fügt die Aufforderung in der Form von "12.90" hinzu, während field.Suggest( 12.90 ) die Aufforderung als 12.9000 hinzufügt.

Eigenschaften

Name Typ Zugriff Beschreibung
Caption string Schreibgeschützt Der im Formular angezeigte Feldname. Der Wert dieser Eigenschaft kann mit der Eigenschaft Name identisch sein.
Children IFields Schreibgeschützt Untergeordnete Objekte des Feldes (Zellen für Tabellen). Nicht verfügbar in Skriptregeln.
FullName string Schreibgeschützt Ein vollständiger Feldname in Bezug auf das Dokument. Ein einzigartige Kennung des Feldes im Dokument. Kann für die Suche nach Dokumentfeldern über die Methode Field verwendet werden. In den Skriptregeln stimmt der zurückgegebene Wert mit dem Namen überein und ist nicht eindeutig.
HasRuleError bool Lesen/Schreiben

Legt fest, ob eine Regelwarnung oder ein Fehler mit dem Feld in Bezug steht.

Hinweis. In In den Skriptregeln legt diese Eigenschaft fest, ob das Feld in der Fehlermeldung angezeigt werden soll.

Eine Regel enthält eine Sammlung von Feldern, die im Dialogfeld Regeleigenschaften. festgelegt werden. Schlägt die Regelüberprüfung fehl, wird eine Fehlermeldung angezeigt (festgelegt in IRuleContext.ErrorMessage) und Links zu den Feldern von der Auflistung werden im Dokumenteditor angezeigt. Durch die Einstellung dieser Eigenschaft auf false wird das Feld von der Linkliste ausgeschlossen, die mit dem Fehler in Verbindung steht.

IsExportable bool Schreibgeschützt Gibt an, ob das Feld für den Export vorgesehen ist (entsprechend den Einstellungen in der Dokumentdefinition).
IsIndexed bool Schreibgeschützt Gibt an, ob das Feld indexierbar ist. Falls ja, steht der Feldwert über die Dokument- und externen Seitenfelder der Dokumentdefinition zur Verfügung.
IsMatched bool Schreibgeschützt Bestimmt, ob das Feld zugeordnet wurde.
IsSuspicious bool Schreibgeschützt Bestimmt, ob der Feldwert eindeutig erkannt wurde.
IsValid bool Schreibgeschützt Bestimmt, ob das Feld keine Formatfehler hat.
IsVerified bool Lesen/Schreiben

Bestimmt, ob das Feld überprüft wird.
Hinweis. Die Eigenschaft funktionieren nicht für Feldgruppe.
Die Eigenschaft kann auch ohne "Schreibberechtigung" für das Feld in den Regeln auf true gesetzt werden. Um die Auswahl des Flags aufzuheben, ist eine "Schreibberechtigung" erforderlich.

Lautet der Wert des Flags true, wird das Feld im Dokumenteditor grau angezeigt, als ob es bereits bestätigt wurde. Lautet der Wert des Flags false, wird das Feld weiß angezeigt und muss bestätigt werden. Nachdem das Feld überprüft wurde, wird das Flag auf true festgelegt.

Hinweis. Die Einstellung dieses Flags auf false stellt keine Weiterleitung des Feldes zur Phase Datenüberprüfung bereit. Verwenden Sie dafür die Eigenschaft NeedVerification der Schnittstellen IField oder ICharacterParams.

IsVisible bool Lesen/Schreiben Gibt an, ob das Feld im Dokumentlayout wiedergegeben werden soll (entsprechend den Einstellungen in der Dokumentdefinition).
Items IFields Schreibgeschützt Instanzen des Feldes (Zeilen von Tabellenfeldern).
Name string Schreibgeschützt Der Feldname in der Dokumentdefinition.
NeedVerification bool Lesen/Schreiben

Gibt an, ob das Feld selbst (nicht dessen Zeichen) eine Überprüfung benötigt.

Lautet der Wert des Flags True, wird das Feld im Dokumenteditor mit einem roten Hintergrund angezeigt, was bedeutet, dass das Feld eine Überprüfung benötigt. Ist die Option An Feldüberprüfung senden in den  Feldeigenschaften ausgewählt, wird das Feld zur Phase Datenüberprüfung weitergeleitet. Nachdem das Feld überprüft wurde, wird das Flag auf false festgelegt..

Um festzulegen, ob bestimmte Zeichen oder das gesamte Feld eine Überprüfung benötigen, verwenden Sie die Eigenschaft NeedVerification vor Schnittstelle  ICharacterParams.

ReadOnly bool Schreibgeschützt Gibt an, ob das Feld "schreibgeschützt" ist (entsprechend den Einstellungen in der Dokumentdefinition). Zeigt bei der Verwendung in Regeln, dass die Regel über eine "Schreibberechtigung" für das Feld verfügt.
ReadOnlyInForm bool Lesen/Schreiben Gibt an, ob das Feld im Formular „schreibgeschützt“ ist (entsprechend den Einstellungen in der Dokumentdefinition).
Regions** IFieldRegions Schreibgeschützt Ein Array von Feldbereichen. Überlaufende Felder können mehrere Regionen besitzen.
Rows IFields Schreibgeschützt Eine Gruppe von Tabellenzeilen. Nicht verfügbar für Felder außerhalb von Tabellen.
Symbols ICharactersParams Schreibgeschützt Detaillierte Informationen über die Symboleigenschaften.
Text string Lesen/Schreiben Die Textdarstellung eines Feldwerts..
Type TExportFieldType Schreibgeschützt Der Feldtyp.
Value VARIANT Lesen/Schreiben Der Feldwert in Form von VARIANT. Die Eigenschaft gibt ein Objekt des Typs Int32 zurück, wenn die Einstellungen des Feldstatus eine ganze Zahl enthalten und der absolute Wert nicht größer als 2147483647 ist. Ist der absolute Feldwert größer als 2147483647, gibt die Eigenschaft ein Objekt des Typs „doppelt“ zurück.

** - Die Eigenschaft ist nicht verfügbar, wenn die Option Advanced Xml Export in den Lizenzeigenschaften deaktiviert wurde.

11/10/2020 12:08:03 PM


Please leave your feedback about this article