> ## 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.

# IField

> IField-Objektreferenz für ABBYY FlexiCapture-Skripte: Feldwerte, Regionen, Symbole, Verifizierungsflags sowie Tabellenzeilen und -zellen lesen und schreiben.

<div id="what-it-does">
  ## Beschreibung
</div>

Ein Dokumentfeld. Der Typ des Felds lässt sich anhand der Eigenschaft **Type** bestimmen. Für Tabellenfelder sind die Objektmethoden **Rows** und **Cell** verfügbar.

<div id="methods">
  ## Methoden
</div>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Definition</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Beschreibung</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>
          AddRegion( page : <a href="/de/flexi-capture/appendix/scripts/ipage">IPage</a>, rect : string ) : <a href="/de/flexi-capture/appendix/scripts/ifieldregion">IFieldRegion</a>
        </p>
      </td>

      <td>
        <p>
          Fügt dem Feld eine Region mit den angegebenen Koordinaten hinzu. <strong>rect</strong> ist die Beschreibung eines Rechtecks im Format \[left,top,right,bottom]. Diese Methode erfordert Schreibberechtigungen
          für das IField-Objekt.
        </p>

        <details>
          <summary>Codebeispiel</summary>
          <p>Codebeispiel, das die Region von Feld 1 nach Feld 2 kopiert:</p>

          <pre>
            <code>field2.AddRegion( field1.Regions\[0].Page, field1.Regions\[0].SurroundingRect.ToString() )</code>
          </pre>
        </details>

        <p>
          <strong>Hinweis: </strong> Diese Methode ist für Tabellen nicht verfügbar. Um eine Region zu löschen, verwenden Sie die Methode <a href="/de/flexi-capture/appendix/scripts/ifieldregion">IFieldRegion</a>.Delete().
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Cell( columnName : string, rowNum : int ) : IField</p>
      </td>

      <td>
        <p>Ruft eine Tabellenzelle anhand des Spaltennamens und der Zeilennummer ab. Nur für Tabellen verfügbar. In Skriptregeln nicht verfügbar.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>CheckRules( )</p>
      </td>

      <td>
        <p>Prüft die Regeln für das angegebene Feld und seine untergeordneten Elemente. Kann nicht in Regeln verwendet werden.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Field( Path : string) : IField</p>
      </td>

      <td>
        <p>
          Sucht das untergeordnete Element relativ zum angegebenen Element. Es werden <a href="/de/flexi-capture/appendix/scripts/scripting-model#pathforming">relative Pfade</a> verwendet. In Regeln können nur Synonyme von Feldnamen verwendet werden, wie
          sie in den Regeleinstellungen definiert sind.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>GetFieldExtractor( )</p>
      </td>

      <td>
        <p>
          Gibt ein <a href="/de/flexi-capture/i-field-extractor">IFieldExtractor</a>-Objekt zurück.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>GetLangs() : IVARAIANTArray</p>
      </td>

      <td>
        <p>Gibt die IDs der in einem Feld erkannten Sprachen zurück.</p>

        <details>
          <summary>Beispiel</summary>

          <p>
            Ein Beispiel für ein <a href="/de/flexi-capture/templates/properties-custom-action">Benutzerskript</a>, das prüft, welche Sprachen in einem Feld vorhanden sind:
          </p>

          <pre>
            <code>var t = Context.Field("Field Name").GetLangs(); var p = ""; foreach (var s in t) \{ p += s.ToString()+","; } FCTools.ShowMessage( "Language " +  p);</code>
          </pre>
        </details>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasField( parameter : string) : bool</p>
      </td>

      <td>
        <p>
          Prüft, ob das Feld mit dem angegebenen Pfad vorhanden ist. Es werden <a href="/de/flexi-capture/appendix/scripts/scripting-model#pathforming">relative Pfade</a> verwendet. In Regeln können nur Synonyme von Feldnamen verwendet werden, wie
          sie in den Regeleinstellungen definiert sind.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Suggest( VARIANT newSuggest )</p>
      </td>

      <td>
        <p>Fügt dem Feld einen Vorschlag hinzu.</p>

        <p>
          <strong>Hinweis: </strong> Kann als Wert oder als Zeichenfolge angegeben werden. Hinzugefügte Werte werden mit vier Dezimalstellen geschrieben.
        </p>

        <p>Zum Beispiel fügt die Methode field.Suggest( "12.90" ) den Vorschlag in der Form "12.90" hinzu, während field.Suggest( 12.90 ) den Vorschlag als 12.9000 hinzufügt.</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="properties">
  ## Eigenschaften
</div>

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Name</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Typ</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Zugriff</strong>
        </p>
      </th>

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Beschreibung</strong>
        </p>
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>
        <p>Beschriftung</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>
          Der Name des Felds, der auf dem Formular angezeigt wird. Der Wert dieser Eigenschaft kann mit dem Wert der Eigenschaft <a href="/de/flexi-capture/appendix/scripts/ifield#propertyname">Name</a> übereinstimmen.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Untergeordnete Elemente</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Untergeordnete Elemente des Feldes (Zellen in Tabellen). In Skriptregeln nicht verfügbar.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>FullName</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>
          Ein vollständiger Feldname relativ zum Dokument. Ein eindeutiger Bezeichner des Felds im Dokument. Kann verwendet werden, um Dokumentfelder über die{" "}
          <a href="/de/flexi-capture/appendix/scripts/scripting-model#pathforming">Field</a>-Methode zu suchen. In Skriptregeln stimmt der zurückgegebene Wert mit{" "}
          <a href="/de/flexi-capture/appendix/scripts/ifield#propertyname">Name</a> überein und ist nicht eindeutig.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasRuleError</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>Gibt an, ob dem Feld eine Regelwarnung oder ein Regelfehler zugeordnet ist.</p>

        <p>
          <strong>Hinweis: </strong> In Skriptregeln gibt diese Eigenschaft an, ob das Feld in der Fehlermeldung angezeigt wird.
        </p>

        <p>
          Eine Regel enthält eine Sammlung von Feldern, die im Dialogfeld <a href="/de/flexi-capture/templates/rule-script">Regeleigenschaften</a>Regeleigenschaften angegeben sind. Wenn die Regelprüfung fehlschlägt, werden eine Fehlermeldung (angegeben in <a href="/de/flexi-capture/appendix/scripts/irulecontext">IRuleContext</a>
          <strong>.ErrorMessage</strong>) und Links zu den Feldern aus der Sammlung im Dokumenteditor angezeigt. Wenn diese Eigenschaft auf <strong>false</strong> festgelegt ist, wird das Feld aus der
          Liste der mit dem Fehler verknüpften Links ausgeschlossen.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsExportable</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Gibt an, ob das Feld für den Export vorgesehen ist (gemäß den Einstellungen der Dokumentdefinition).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsIndexed</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Gibt an, ob das Feld indizierbar ist. Falls ja, kann der Feldwert in den externen Feldern für Dokumente und Seiten in der Document Definition verfügbar sein.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsMatched</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Gibt an, ob das Feld zugeordnet wurde.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsSuspicious</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Gibt an, ob der Feldwert zweifelsfrei erkannt wurde.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsValid</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Gibt an, ob das Feld keine Formatfehler enthält.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsVerified</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>
          Gibt an, ob das Feld verifiziert ist. <br />
          <strong>Hinweis: </strong> Die Eigenschaft funktioniert nicht für <a href="/de/flexi-capture/templates/field-group">Feldgruppen</a>Feldgruppen.

          <br />

          Die Eigenschaft kann in Regeln auch ohne „Schreib“-Berechtigung für das Feld auf <strong>true</strong> gesetzt werden. Um das Flag zurückzusetzen, ist die „Schreib“-Berechtigung erforderlich.
        </p>

        <p>
          Wenn das Flag <strong>true</strong> ist, wird das Feld im Dokumenteditor grau angezeigt, als wäre es bereits bestätigt. Wenn das Flag <strong>false</strong> ist, wird das Feld weiß angezeigt
          und muss bestätigt werden. Sobald das Feld verifiziert ist, wird das Flag auf <strong>true</strong> gesetzt.
        </p>

        <p>
          <strong>Hinweis: </strong> Wenn dieses Flag auf <strong>false</strong> gesetzt wird, wird das Feld dadurch nicht an die Stufe „Datenverifizierung“ weitergeleitet. Verwenden Sie hierfür die{" "}
          Eigenschaft <strong>NeedVerification</strong> der Schnittstellen IField oder <a href="/de/flexi-capture/appendix/scripts/icharacterparams">ICharacterParams</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsVisible</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lesen/Schreiben</p>
      </td>

      <td>
        <p>Gibt an, ob das Feld im Dokumentlayout angezeigt werden soll (gemäß der Einstellung der Dokumentdefinition).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Elemente</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Instanzen des Feldes (Zeilen in Tabellenfeldern).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          <a id="propertyname" />Name
        </p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Der Feldname in der Document Definition.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>NeedVerification</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>Gibt an, ob das Feld selbst (nicht seine Zeichen) verifiziert werden muss.</p>

        <p>
          Wenn das Flag auf <strong>true</strong> gesetzt ist, wird das Feld im Dokumenteditor auf rotem Hintergrund angezeigt. Das bedeutet, dass das Feld verifiziert werden muss. Wenn die Option Send to field verification
          in den <a href="/de/flexi-capture/templates/properties-verification">Feldeigenschaften</a>Feldeigenschaften ausgewählt ist, wird das Feld an die Stufe Data Verification weitergeleitet. Sobald das
          Feld verifiziert wurde, wird das Flag auf <strong>false</strong> gesetzt.
        </p>

        <p>
          Um anzugeben, ob bestimmte Zeichen, aber nicht das gesamte Feld, verifiziert werden müssen, verwenden Sie die Eigenschaft <strong>NeedVerification</strong> der{" "}
          <a href="/de/flexi-capture/appendix/scripts/icharacterparams">ICharacterParams</a>-Schnittstelle.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ReadOnly</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>
          Gibt an, ob das Feld schreibgeschützt ist (gemäß den Einstellungen der Dokumentdefinition). Bei Verwendung in Regeln gibt die Eigenschaft an, dass die Regel Schreibberechtigung für das Feld hat.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ReadOnlyInForm</p>
      </td>

      <td>
        <p>bool</p>
      </td>

      <td>
        <p>Lesen/Schreiben</p>
      </td>

      <td>
        <p>Gibt an, ob das Feld im Formular mit den Berechtigungen „nur lesbar“ versehen ist (gemäß den Einstellungen der Dokumentdefinition).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          Regionen<a href="#condition">\*\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/ifieldregions">IFieldRegions</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Ein Array von Feldregionen. Überlaufende Felder können aus mehreren Regionen bestehen.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Zeilen</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/ifields">IFields</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Eine Sammlung von Tabellenzeilen. Für Nicht-Tabellenfelder nicht verfügbar.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Symbole</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/icharactersparams">ICharactersParams</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Detaillierte Informationen zu den Eigenschaften der Symbole.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Text</p>
      </td>

      <td>
        <p>string</p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>Die Textdarstellung eines Feldwerts.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Typ</p>
      </td>

      <td>
        <p>
          <a href="/de/flexi-capture/appendix/scripts/texportfieldtype">TExportFieldType</a>
        </p>
      </td>

      <td>
        <p>Schreibgeschützt</p>
      </td>

      <td>
        <p>Der Typ eines Feldes.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Value</p>
      </td>

      <td>
        <p>VARIANT</p>
      </td>

      <td>
        <p>Lese-/Schreibzugriff</p>
      </td>

      <td>
        <p>
          Der Wert des Feldes als VARIANT. Die Eigenschaft gibt ein Objekt vom Typ Int32 zurück, wenn die Einstellungen des Feldes angeben, dass es eine Ganzzahl enthält und ihr absoluter Wert nicht
          größer als 2147483647 ist. Wenn der absolute Wert des Feldes größer als 2147483647 ist, gibt die Eigenschaft ein Objekt vom Typ double zurück.
        </p>
      </td>
    </tr>
  </tbody>
</table>

<a id="condition" />\*\* - Die Eigenschaft ist nicht verfügbar, wenn die Option „Erweiterter XML-Export“ in den Eigenschaften der Lizenz nicht ausgewählt ist.