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

> Référence de l’objet IField pour les scripts ABBYY FlexiCapture : lire et écrire les valeurs des champs, les régions, les symboles, les indicateurs de vérification, ainsi que les lignes et les cellules de tableau.

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

Un champ de document. Le type du champ est indiqué par la propriété **Type**. Pour les champs de tableau, les méthodes d’objet **Rows** et **Cell** sont disponibles.

<div id="methods">
  ## Méthodes
</div>

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

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

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

      <td>
        <p>
          Ajoute au champ une région avec les coordonnées spécifiées. <strong>rect</strong> est une description de rectangle au format \[left,top,right,bottom]. Cette méthode nécessite des droits d’écriture
          sur l’objet IField.
        </p>

        <details>
          <summary>Exemple de code</summary>
          <p>Exemple de code qui copie la région du champ 1 vers le champ 2 :</p>

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

        <p>
          <strong>Remarque : </strong> Cette méthode n’est pas disponible pour les tableaux. Pour supprimer une région, utilisez la méthode <a href="/fr/flexi-capture/appendix/scripts/ifieldregion">IFieldRegion</a>.Delete().
        </p>
      </td>
    </tr>

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

      <td>
        <p>Récupère une cellule de tableau à partir du nom de colonne et du numéro de ligne. Disponible uniquement pour les tableaux. Indisponible dans les script rules.</p>
      </td>
    </tr>

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

      <td>
        <p>Vérifie les règles du champ donné et de ses enfants. Ne peut pas être utilisé dans les règles.</p>
      </td>
    </tr>

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

      <td>
        <p>
          Recherche l’élément enfant par rapport à l’élément donné. Des <a href="/fr/flexi-capture/appendix/scripts/scripting-model#pathforming">chemins relatifs</a> sont utilisés. Seuls les synonymes des noms de champ tels
          qu’ils sont définis dans les paramètres des règles peuvent être utilisés dans les règles.
        </p>
      </td>
    </tr>

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

      <td>
        <p>
          Retourne un objet <a href="/fr/flexi-capture/i-field-extractor">IFieldExtractor</a>.
        </p>
      </td>
    </tr>

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

      <td>
        <p>Retourne les ID des langues détectées dans un champ.</p>

        <details>
          <summary>Exemple</summary>

          <p>
            Exemple de <a href="/fr/flexi-capture/templates/properties-custom-action">script utilisateur</a> qui vérifie quelles langues sont présentes dans un champ :
          </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>
          Vérifie si le champ correspondant au chemin spécifié existe. Des <a href="/fr/flexi-capture/appendix/scripts/scripting-model#pathforming">chemins relatifs</a> sont utilisés. Seuls les synonymes des noms de champ tels
          qu’ils sont définis dans les paramètres des règles peuvent être utilisés dans les règles.
        </p>
      </td>
    </tr>

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

      <td>
        <p>Ajoute un prompt au champ.</p>

        <p>
          <strong>Remarque : </strong> Il peut prendre la forme d’une valeur ou d’une chaîne. Les valeurs ajoutées sont écrites avec quatre décimales.
        </p>

        <p>Par exemple, la méthode field.Suggest( "12.90" ) ajoute le prompt sous la forme de "12.90", tandis que field.Suggest( 12.90 ) l’ajoute sous la forme 12.9000.</p>
      </td>
    </tr>
  </tbody>
</table>

<div id="properties">
  ## Propriétés
</div>

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

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

      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Accès</strong>
        </p>
      </th>

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

  <tbody>
    <tr>
      <td>
        <p>Légende</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>
          Nom du champ affiché sur le formulaire. La valeur de cette propriété peut être identique à celle de la propriété <a href="/fr/flexi-capture/appendix/scripts/ifield#propertyname">Name</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Children</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Éléments enfants du champ (cellules de tableau). Indisponible dans les règles de script.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>
          Nom complet du champ dans le document. Identifiant unique du champ dans le document. Peut être utilisé pour rechercher des champs de document à l’aide de la méthode{" "}
          <a href="/fr/flexi-capture/appendix/scripts/scripting-model#pathforming">Field</a>. Dans les règles de script, la valeur renvoyée coïncide avec{" "}
          <a href="/fr/flexi-capture/appendix/scripts/ifield#propertyname">Name</a> et n’est pas unique.
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>Indique si un avertissement ou une erreur de règle est associé au champ.</p>

        <p>
          <strong>Remarque : </strong> Dans les règles de script, cette propriété indique s’il faut afficher le champ dans le message d’erreur.
        </p>

        <p>
          Une règle inclut une collection de champs spécifiés dans la <a href="/fr/flexi-capture/templates/rule-script">propriétés de la règle</a>boîte de dialogue des propriétés de la règle. Si la vérification de la règle échoue, un
          message d’erreur (spécifié dans <a href="/fr/flexi-capture/appendix/scripts/irulecontext">IRuleContext</a>
          <strong>.ErrorMessage</strong>) ainsi que des liens vers les champs de la collection s’affichent dans l’éditeur de documents. Définir cette propriété sur <strong>false</strong> exclut le champ de la
          liste des liens associés à l’erreur.
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Indique si le champ est destiné à l’exportation (conformément aux paramètres de la définition de document).</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Indique si le champ est indexable. Si oui, la valeur du champ peut être accessible à partir des champs externes du document et de la page dans la Document Definition.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Indique si le champ est associé.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Indique si la valeur du champ est reconnue avec certitude.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Indique si le champ ne contient aucune erreur de format.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>
          Indique si le champ est vérifié. <br />
          <strong>Remarque : </strong> La propriété ne fonctionne pas pour les <a href="/fr/flexi-capture/templates/field-group">groupes de champs</a>groupes de champs.

          <br />

          La propriété peut être définie sur <strong>true</strong> dans les règles, même sans autorisations "write" pour le champ. Pour désactiver l’indicateur, des autorisations "write" sont requises.
        </p>

        <p>
          Si l’indicateur est <strong>true</strong>, le champ s’affiche en gris dans l’éditeur de documents, comme s’il était déjà confirmé. Si l’indicateur est <strong>false</strong>, le champ s’affiche en blanc
          et doit être confirmé. Une fois le champ vérifié, l’indicateur est défini sur <strong>true</strong>.
        </p>

        <p>
          <strong>Remarque : </strong> Définir cet indicateur sur <strong>false</strong> n’achemine pas le champ vers l’étape de vérification des données. Pour cela, utilisez la propriété <strong>NeedVerification</strong>{" "}
          de l’interface IField ou de l’interface <a href="/fr/flexi-capture/appendix/scripts/icharacterparams">ICharacterParams</a>.
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>Indique si le champ doit apparaître dans la mise en page du document (selon les paramètres de la définition de document).</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Items</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Instances du champ (lignes des champs de type tableau).</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Nom du champ dans Document Definition.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>Indique si le champ lui-même (et non ses caractères) nécessite une vérification.</p>

        <p>
          Si l’indicateur vaut <strong>true</strong>, le champ s’affiche sur un fond rouge dans l’éditeur de documents, ce qui signifie qu’il doit être vérifié. Si l’option Send to field verification
          est sélectionnée dans les <a href="/fr/flexi-capture/templates/properties-verification">propriétés du champ</a>propriétés du champ, le champ sera acheminé vers l’étape de vérification des données. Une fois le
          champ vérifié, l’indicateur prend la valeur <strong>false</strong>.
        </p>

        <p>
          Pour indiquer si certains caractères, mais pas le champ entier, nécessitent une vérification, utilisez la propriété <strong>NeedVerification</strong> de l’interface{" "}
          <a href="/fr/flexi-capture/appendix/scripts/icharacterparams">ICharacterParams</a>.
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>
          Indique si le champ dispose de l’autorisation « lecture seule » (conformément aux paramètres de la définition de document). Dans les règles, indique que la règle dispose de l’autorisation « écriture » pour le champ.
        </p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>Indique si le champ du formulaire est en "lecture seule" (conformément aux paramètres de la définition de document).</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Un tableau de régions de champ. Les champs débordant sur plusieurs zones peuvent avoir plusieurs régions.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Lignes</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Ensemble de lignes d’un tableau. Non disponible pour les champs qui ne sont pas des tableaux.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Symboles</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Informations détaillées sur les propriétés des symboles.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>La représentation textuelle de la valeur d’un champ.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Type</p>
      </td>

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

      <td>
        <p>Lecture seule</p>
      </td>

      <td>
        <p>Le type du champ.</p>
      </td>
    </tr>

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

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

      <td>
        <p>Lecture/écriture</p>
      </td>

      <td>
        <p>
          La valeur du champ sous forme de VARIANT. La propriété renvoie un objet de type Int32 si les paramètres du champ indiquent qu’il contient un entier et que sa valeur absolue n’est pas
          supérieure à 2147483647. Si la valeur absolue du champ est supérieure à 2147483647, la propriété renvoie un objet de type double.
        </p>
      </td>
    </tr>
  </tbody>
</table>

<a id="condition" />\*\* - La propriété n’est pas disponible si l’option Export XML avancé n’est pas sélectionnée dans les propriétés de la License.