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

# IDocument

> Référence de l’objet IDocument pour les scripts ABBYY FlexiCapture : accès aux champs du document, aux pages, aux règles, aux résultats d’export, aux propriétés et à l’état de traitement.

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

Représente un document.

<a id="webverificationavailableinterface" />

<Note>
  Certaines méthodes et propriétés de cet objet ne sont pas disponibles dans Web Verification Station pour la vérification locale des règles. Les méthodes et propriétés non prises en charge sont signalées par un astérisque (\*).
</Note>

<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>
          AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Ajoute un fichier utilisateur aux résultats d’export du document.</p>

        <p>
          Dans le paramètre <strong>sourceFile </strong>, indiquez le chemin du fichier utilisateur à ajouter.
        </p>

        <p>
          <strong>Remarque : </strong> Veillez à spécifier le chemin d’export racine dans les paramètres du projet. Sinon, le fichier utilisateur sera placé dans le dossier du lot à l’emplacement de stockage des fichiers.
        </p>

        <p>
          Dans le paramètre <strong>destinationName </strong>, indiquez une destination d’export.
        </p>

        <p>
          Définissez le paramètre <strong>replaceIfExists</strong> sur <em>true</em> si vous souhaitez écraser tout fichier existant portant le même nom dans la destination. Définissez le paramètre <strong>replaceIfExists</strong>{" "}
          sur <em>false</em> si vous souhaitez conserver tout fichier existant portant le même nom dans la destination et ajouter un message d’erreur au Log.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          CheckRules( ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Vérifie toutes les règles du document. Des droits d’écriture sur le document sont requis.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          Field( name : string ) : <a href="/fr/flexi-capture/appendix/scripts/ifield">IField</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Permet d’accéder à un champ de document à l’aide du chemin complet vers le champ. Des <a href="/fr/flexi-capture/appendix/scripts/scripting-model#pathforming">chemins complets</a> sont utilisés.
        </p>

        <p>
          Il s’agit d’un champ interne<a href="#loadintomemoryrequired">\*\*</a>. Ne peut pas être utilisé dans les règles.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          HasField( name : string ) : bool <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Vérifie si un champ existe au chemin spécifié. Des <a href="/fr/flexi-capture/appendix/scripts/scripting-model#pathforming">chemins relatifs</a> sont utilisés.
        </p>

        <p>
          Il s’agit d’un champ interne<a href="#loadintomemoryrequired">\*\*</a>. Il ne peut pas être utilisé dans les règles.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          IndexedItemValue( name : string ) : VARIANT <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Récupère la valeur du champ à partir de son nom ou de son chemin d’accès. Disponible pour les champs externes des documents et des pages. Le nom du champ comme son{" "}
          <a href="/fr/flexi-capture/appendix/scripts/scripting-model#pathforming">chemin complet</a> peuvent être utilisés. Ne peut pas être utilisé dans les règles.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          IndexedItemValues( name : string ) : <a href="/fr/flexi-capture/appendix/scripts/ivariant">IVARIANTArray</a> <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Récupère un ensemble de valeurs d’index correspondant à un champ dans la définition de document, à partir du nom ou du chemin du champ. Si un champ est marqué comme champ d’index dans la section répétée, la
          méthode renvoie toutes les valeurs du champ de toutes les sections. Disponible pour les champs externes des documents et des pages. Le nom du champ ou son{" "}
          <a href="/fr/flexi-capture/appendix/scripts/scripting-model#pathforming">chemin complet</a> peuvent être utilisés. Ne peut pas être utilisé dans les règles.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Property( name : string ) : VARIANT</p>
      </td>

      <td>
        <p>Récupère la valeur d’une propriété spécifiée par son nom. La valeur renvoyée peut être de type string, numérique ou horaire.</p>
        <p>Noms des propriétés et valeurs renvoyées :</p>

        <ul>
          <li>Exported - date d’exportation du document</li>
          <li>ExportedBy - utilisateur ayant exporté le document</li>
          <li>Created - date de création du document</li>
          <li>CreatedBy - utilisateur ayant créé le document</li>
          <li>Recognized - date de reconnaissance du document</li>
          <li>RecognizedBy - utilisateur ayant reconnu le document</li>
          <li>Modified - date de la dernière modification du document</li>
          <li>ModifiedBy - utilisateur ayant modifié le document</li>
          <li>TotalSymbolsCount - nombre total de symboles</li>
          <li>UncertainSymbolsCount - nombre total de symboles incertains</li>
          <li>RecognizedSymbolsCount - nombre de symboles reconnus</li>
          <li>Comment - commentaire du document</li>
          <li>ProcessingErrors - erreurs de traitement du document</li>
          <li>ProcessingWarnings - avertissements de traitement du document</li>
        </ul>

        <ul>
          <li>Verified - heure de la dernière modification manuelle des champs du document</li>
          <li>VerifiedBy - utilisateur ayant effectué les dernières modifications manuelles des champs du document (n’enregistre pas les informations des Processing Stations)</li>
        </ul>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveAs( filename : string, \[optional] options : <a href="/fr/flexi-capture/appendix/scripts/iexportimagesavingoptions">IExportImageSavingOptions</a> ){" "}
          <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          Enregistre l’image d’un document d’une seule page ou de plusieurs pages. Si aucun format d’enregistrement n’est spécifié dans les options d’enregistrement, l’image est enregistrée dans un fichier \*.tif. Il s’agit d’un
          <a href="#loadintomemoryrequired">\*\*</a> champ interne.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveAsStream( \[optional] options: <a href="/fr/flexi-capture/appendix/scripts/iexportimagesavingoptions">IExportImageSavingOptions</a>) : byte\[]{" "}
          <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Enregistre le document dans un flux en mémoire et le renvoie sous forme de tableau d’octets (COM SafeArray).</p>

        <p>
          <strong>Remarque : </strong> JScript et VBScript ne prennent pas en charge l’itération dans ce tableau.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveXmlToFile( filename : string ) <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Enregistre à l’emplacement spécifié le fichier XML décrivant le document sans prétraitement, en vue de son utilisation dans Web Verification Station.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          SaveXmlToFileStorage() <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>Enregistre dans le stockage de fichiers le fichier XML contenant la description du document sans prétraitement, afin qu'il puisse être utilisé dans Web Verification Station.</p>
      </td>
    </tr>
  </tbody>
</table>

<Note>
  La méthode **Property** ne doit pas être confondue avec la collection **Properties**, qui contient les propriétés du document définies par l’utilisateur.
</Note>

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

<table width="100%">
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        <p>
          <strong>Nom</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>
          Action <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/iactionresult">IActionResult</a>
        </p>
      </td>

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

      <td>
        <p>N’est disponible que dans les scripts d’Export et de post-export.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          AsBatchItem <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>
        </p>
      </td>

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

      <td>
        <p>
          Convertit le document en objet <a href="/fr/flexi-capture/appendix/scripts/i-batch-item">IBatchItem</a>.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>AssemblingErrors</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/iassemblingerrors">IAssemblingErrors</a>
        </p>
      </td>

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

      <td>
        <p>Une collection d’erreurs d’assemblage. L’accès à cette collection est toujours en lecture seule.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Pièces jointes</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/iattachments">IUserAttachments</a>
        </p>
      </td>

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

      <td>
        <p>Pièces jointes utilisateur</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Lot</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/ibatch">IBatch</a>
        </p>
      </td>

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

      <td>
        <p>
          Le lot. Quelles que soient les autorisations du script pour le document, l'accès au lot est en lecture seule et les champs internes<a href="#loadintomemoryrequired">\*\*</a> des documents et des
          pages ne sont pas accessibles.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>BatchName</p>
      </td>

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

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

      <td>
        <p>Nom du lot.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          Enfants <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

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

      <td>
        <p>
          Champs enfants (sections du document). Contrairement à la propriété <strong>Sections</strong>, l'ordre des sections correspond à celui défini dans la Document Definition. Les sections récurrentes sont représentées par un seul
          élément, et les instances sont accessibles via la méthode <strong>Items</strong> de cet élément.
        </p>

        <p>
          Il s'agit d'un champ interne<a href="#loadintomemoryrequired">\*\*</a>. Il ne peut pas être utilisé dans les règles.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Commentaire</p>
      </td>

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

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

      <td>
        <p>Commentaire du document.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>DefinitionName</p>
      </td>

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

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

      <td>
        <p>Le nom de la définition de document.</p>
        <p>Pour les documents non traités et non reconnus, la propriété renvoie une chaîne vide.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>DocumentDefinition</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/idocinfo">IDocumentDefinitionInfo</a>
        </p>
      </td>

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

      <td>
        <p>Informations détaillées sur la définition de document associée au document.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasErrors</p>
      </td>

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

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

      <td>
        <p>Indique si le document contient des erreurs sur un seul champ ou sur plusieurs champs.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasUnpreparedImages</p>
      </td>

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

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

      <td>
        <p>Indique si le document contient des pages non prétraitées.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>HasWarnings</p>
      </td>

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

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

      <td>
        <p>Indique si le document comporte des avertissements liés aux règles ou au format.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>ID</p>
      </td>

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

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

      <td>
        <p>Identifiant du document (ID externe). La valeur commence par 1 et n’est unique qu’au sein d’un lot.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Index</p>
      </td>

      <td>
        <p>int</p>
      </td>

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

      <td>
        <p>L’indice du document dans le lot. La valeur commence à 0 et n’est unique que dans une même tâche.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsAnalyzed</p>
      </td>

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

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

      <td>
        <p>Indique si le document est analysé. Le document est considéré comme analysé si toutes les pages du document sont analysées.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsAssembled</p>
      </td>

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

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

      <td>
        <p>Indique si le document a été assemblé.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsExcludedFromAutomaticAssembling</p>
      </td>

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

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

      <td>
        <p>Indique si le document est inclus dans l’assemblage automatique.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsExported</p>
      </td>

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

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

      <td>
        <p>Indique si le document a été exporté.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsRecognized</p>
      </td>

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

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

      <td>
        <p>Indique si le document a été reconnu. Le document est considéré comme reconnu si chaque page du document est soit reconnue, soit une page annexe.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>IsUsedForTraining</p>
      </td>

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

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

      <td>
        <p>Indique si le document est utilisé pour l’entraînement.</p>
      </td>
    </tr>

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

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

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

      <td>
        <p>Indique si le document est vérifié.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Pages</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/ipages">IPages</a>
        </p>
      </td>

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

      <td>
        <p>Pages du document.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          PreviousStageInfo <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a>
        </p>
      </td>

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

      <td>
        <p>
          Renvoie l’objet <a href="/fr/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a>, c’est-à-dire l’étape de traitement précédente du document. Les champs <strong>TaskId</strong> et{" "}
          <strong>PrincipalId</strong> ne sont pas utilisés.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Priorité</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/tprocessingpriority-appendix-scripts">TProcessingPriority</a>
        </p>
      </td>

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

      <td>
        <p>Priorité du document.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          ProcessingErrors <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

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

      <td>
        <p>Erreurs de traitement séparées par des retours à la ligne.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          ProcessingWarnings <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

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

      <td>
        <p>Avertissements de traitement, séparés par des sauts de ligne.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          ProhibitedUserId <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>int</p>
      </td>

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

      <td>
        <p>Une tâche créée à partir du document ne sera pas accessible à l’utilisateur ayant l’identifiant indiqué. Par défaut, la valeur est "0", ce qui signifie que la tâche est accessible à tous les utilisateurs.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>Propriétés</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/iproperties">IProperties</a>
        </p>
      </td>

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

      <td>
        <p>Paramètres d’enregistrement du document.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          RecognizedSymbolsCount <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>int</p>
      </td>

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

      <td>
        <p>Le nombre de symboles reconnus.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          RuleErrors <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/iruleerrors">IRuleErrors</a>
        </p>
      </td>

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

      <td>
        <p>Collection d’erreurs de document (erreurs de format, erreurs de règle, erreurs liées à la fusion des résultats de la double vérification).</p>

        <p>
          <strong>Remarque : </strong> Disponible uniquement pour les documents ouverts.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>
          Sections <a href="#webverificationavailableinterface">\*</a>
        </p>
      </td>

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

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

      <td>
        <p>
          Une liste à plat des sections du document. S'il existe une section récurrente, la liste contient toutes les occurrences de cette section. Les sections de la liste suivent le même ordre que les premières pages des
          sections du document. Les sections sans pages figurent à la fin de la liste.
        </p>

        <p>
          Il s'agit d'un champ interne<a href="#loadintomemoryrequired">\*\*</a>. Il ne peut pas être utilisé dans les règles.
        </p>
      </td>
    </tr>

    <tr>
      <td>
        <p>StageInfo</p>
      </td>

      <td>
        <p>
          <a href="/fr/flexi-capture/appendix/scripts/istageinfo">IStageInfo</a>
        </p>
      </td>

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

      <td>
        <p>Informations sur l’étape de traitement du serveur d’applications.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>SymbolsForVerificationCount</p>
      </td>

      <td>
        <p>int</p>
      </td>

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

      <td>
        <p>Le nombre de symboles à vérifier.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>TotalSymbolsCount</p>
      </td>

      <td>
        <p>int</p>
      </td>

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

      <td>
        <p>Nombre total de symboles.</p>
      </td>
    </tr>

    <tr>
      <td>
        <p>UncertainSymbolsCount</p>
      </td>

      <td>
        <p>int</p>
      </td>

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

      <td>
        <p>Le nombre de symboles incertains.</p>
      </td>
    </tr>
  </tbody>
</table>

<a id="loadintomemoryrequired" />\*\* - Le champ interne nécessite que l’objet soit chargé en mémoire.