IDocument

Effet produit

Représente le document.

Remarque. Certaines méthodes et certaines propriétés de cet objet ne sont pas disponibles sur le poste de vérification Web pour la vérification des règles localement. Les méthodes et les propriétés non prises en charge sont signalées par un astérisque (*).

Méthodes

Définition Description
AddFileToExportResults( sourceFile : chaîne, destinationName : chaîne, replaceIfExists : bool) *

Ajoute un fichier utilisateur pour documenter les résultats d'exportation.

Dans le paramètre sourceFile , spécifiez l'adresse du fichier utilisateur à ajouter.

Remarque :Assurez-vous de spécifier le chemin d'exportation racine dans les paramètres du projet. Sinon, le fichier utilisateur sera placé dans le dossier du lot dans l'emplacement de stockage du fichier.

Dans le paramètre destinationName , spécifiez une destination d'exportation.

Définissez le paramètre replaceIfExists sur true si vous souhaiter écraser un fichier existant portant le même nom dans la destination. Définissez le paramètre replaceIfExists sur false si vous souhaitez conserver un fichier existant portant le même nom dans la destination et ajouter un message d'erreur au journal.

CheckRules( ) * Vérifie toutes les règles contenues dans le document. Des droits en écriture sont nécessaires pour le document.
Field( name : chaîne ) : IField *

Donne l'accès à un champ du document via le chemin d'accès complet du champ. Les Chemins d'accès complets sont utilisés.

Est un champ** interne. Impossible à utiliser dans les règles.

HasField( name : chaîne ) : booléen *

Vérifie si un champ existe pour le chemin d'accès spécifié. Les Chemins d'accès relatifs sont utilisés.

Est un champ** interne. Impossible à utiliser dans les règles.

IndexedItemValue( name : chaîne ) : VARIANT * Récupère la valeur du champ via son nom ou son chemin d'accès. Disponible à partir de champs externes de documents et de pages. Un nom de champ et un chemin d'accès complet du champ peuvent tous deux être utilisés. Impossible à utiliser dans les règles.
IndexedItemValues( name : chaîne ) : IVARIANTArray * Récupère un ensemble de valeurs d'indices correspondant à un champ de la définition de document via son nom ou son chemin d'accès. Si un champ est signalé en tant que champ d'index dans la section récurrente, la méthode renvoie toutes les valeurs du champ de toutes les sections. Disponible à partir de champs externes de documents et de pages. Un nom de champ et un chemin d'accès complet du champ peuvent tous deux être utilisés. Impossible à utiliser dans les règles.
Property( name : chaîne ) : VARIANT

Récupère la valeur d'une propriété spécifique via son nom. La valeur retournée peut être retournée sous la forme d'une chaîne, d'un nombre ou d'une heure.

Noms de propriétés et valeurs retournées :

  • Exported : date à laquelle le document a été exporté
  • ExportedBy : personne ayant exporté le document
  • Created : date à laquelle le document a été créé
  • CreatedBy : personne ayant créé le document
  • Recognized date à laquelle le document a été reconnu
  • RecognizedBy : personne ayant reconnu le document
  • Modified : dernière date à laquelle le document a été modifié
  • ModifiedBy : personne ayant modifié le document
  • TotalSymbolsCount : nombre total de symboles
  • UncertainSymbolsCount : nombre total de symboles incertains
  • RecognizedSymbolsCount : nombre de symboles reconnus
  • Comment : commentaire sur le document
  • ProcessingErrors erreurs de traitement du document
  • ProcessingWarnings : avertissements de traitement du document
  • Verified : l'heure de la dernière modification manuelle des champs des documents
  • VerifiedBy : l'utilisateur qui a apporté les dernières modifications manuelles aux champs du document (n'enregistre pas les informations des postes de traitement)
SaveAs( filename : chaîne, [optional] options : IExportImageSavingOptions ) * Enregistre l'image du document. Par défaut, si les options ne sont pas spécifiées, l'image est enregistrée au format *.tif. Est un champ** interne.
SaveAsStream( [optional] options: IExportImageSavingOptions) : byte[] *

Enregistre le document dans un flux de mémoire et le retourne sous forme de matrice d'octets (COM SafeArray).

Remarque :JScript et VBScript ne prennent pas en charge itération sur cette matrice.

SaveXmlToFile( filename : chaîne ) * Enregistre le fichier XML et la description du document sans prétraitement dans l'emplacement spécifié comme devant être utilisé sur le poste de vérification Web..
SaveXmlToFileStorage() * Enregistre le fichier XML et la description du document sans prétraitement dans le stockage de fichiers devant être utilisé sur le poste de vérification Web.

Important !La méthode Property ne doit pas être confondue avec l'ensemble Propriétés contenant les propriétés du document spécifiées par l'utilisateur.

Propriétés

Nom Type Accès Description
Action * IActionResult Lecture seule Ne s'applique qu'aux scripts d'exportation et de post-exportation.
AsBatchItem * IBatchItem Lecture seule Convertit le document en un objet IBatchItem.
AssemblingErrors IAssemblingErrors Lecture seule Un ensemble d'erreurs d'assemblage. L'accès à l'ensemble est toujours en lecture seule.
Attachments IUserAttachments Lecture seule Pièces jointes de l'utilisateur
Batch IBatch Lecture seule 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** des documents et des pages ne sont pas accessibles.
BatchName chaîne Lecture seule Le nom du lot.
Children * IFields Lecture seule

Champs enfants (sections du document). Contrairement à ce qui se produit avec la propriété Sections, l'ordre des sections correspond à celui de la définition de document. Les sections récurrentes sont représentées sous la forme d'un seul élément et les instances sont disponibles via la méthode Items de cet élément.  

Est un champ** interne. Impossible à utiliser dans les règles.

Comment chaîne Lecture/écriture Un commentaire du document.
DefinitionName chaîne Lecture seule Le nom de la définition de document.
DocumentDefinition IDocumentDefinitionInfo Lecture seule

Informations détaillées sur la définition de document associée au document.

Pour les documents non traités et non reconnus, la propriété retourne une chaîne vide.

HasErrors booléen Lecture seule Indique si le document comporte des erreurs de règle ou de format.
HasUnpreparedImages booléen Lecture seule Indique si le document contient des pages non prétraitées.
HasWarnings booléen Lecture seule Indique si le document comporte des avertissements de règle ou de format.
Id chaîne Lecture seule Identificateur de document (ID externe). La valeur commence par 1 et est unique seulement dans un lot.
Index entier Lecture seule L'index du document dans le lot. La valeur commence par 0 et est unique seulement dans une tâche.
IsAnalyzed booléen Lecture seule Indique si le document est analysé. Le document est considéré comme analysé si toutes les pages du document sont analysées.
IsAssembled booléen Lecture seule Specifies whether the document is assembled.
IsExcludedFromAutomaticAssembling booléen Lecture/écriture Vérifie si le document est inclus dans l'assemblage automatique.
IsExported booléen Lecture seule Indique si le document est exporté.
IsRecognized booléen Lecture seule Indique si le document est reconnu. Le document est considéré comme reconnu si chaque page du document est reconnue ou s'il s'agit d'une page d'annexe.
IsUsedForTraining booléen Lecture/écriture Précise si le document est utilisé pour l'apprentissage.
IsVerified booléen Lecture seule Indique si le document est vérifié.
Pages IPages Lecture seule Pages du document.
PreviousStageInfo * IStageInfo Lecture seule Retourne l'objet IStageInfo, c'est-à-dire l'étape de traitement du document. Les champs TaskId et PrincipalId ne sont pas utilisés..
Priority TProcessingPriority Lecture seule Une priorité du document.
ProcessingErrors * chaîne Lecture seule Erreurs de traitement séparées par des sauts de ligne.
ProcessingWarnings * chaîne Lecture seule Avertissements séparés par des sauts de ligne.
ProhibitedUserId * entier Lecture seule Une tâche créée à partir du document ne sera pas accessible à l'utilisateur ayant l'identificateur défini. Par défaut, la valeur est « 0 », ce qui signifie que la tâche est accessible à tous les utilisateurs.
Properties IProperties Lecture seule Les paramètres d’enregistrement du document.
RecognizedSymbolsCount * entier Lecture seule Le nombre de symboles reconnus.
RuleErrors * IRuleErrors Lecture seule

Un ensemble d'erreurs de documents (erreurs de format, erreurs de règle, erreurs de fusion des résultats de la double vérification).

Remarque :Uniquement disponible pour les documents ouverts.

Sections * IFields Lecture seule

Une liste à plat des sections de documents. En cas de section récurrente, la liste contient toutes les répétitions de la section. Les sections dans la liste suivent le même ordre que les premières pages des sections de documents. Les sections sans pages ferment la liste

Est un champ** interne. Impossible à utiliser dans les règles.

StageInfo IStageInfo Lecture seule Informations sur l'étape de traitement du serveur d'application.
SymbolsForVerificationCount entier Lecture seule Le nombre de symboles à vérifier.
TotalSymbolsCount entier Lecture seule Le nombre total de symboles.
UncertainSymbolsCount entier Lecture seule Le nombre de symboles incertains.

** - le champ interne nécessite le chargement de l'objet dans la mémoire.

01.12.2020 7:04:01


Please leave your feedback about this article