IDocument - ABBYY Documentation

Représente un document.

Certaines méthodes et propriétés de cet objet ne sont pas disponibles sur la 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 (*).

Méthodes

Méthode	Description
`AddFileToExportResults( sourceFile : string, destinationName : string, replaceIfExists : bool )` *	Ajoute un fichier utilisateur aux résultats d’export de documents. Dans le paramètre `sourceFile`, indiquez l’adresse du fichier utilisateur à ajouter. Veillez à définir le chemin d’export racine dans les paramètres du projet. Sinon, le fichier utilisateur est placé dans le dossier du lot, à l’emplacement de stockage des fichiers. Dans le paramètre `destinationName`, indiquez une destination d’export. Définissez le paramètre `replaceIfExists` sur `true` pour remplacer tout fichier existant portant le même nom dans la destination. Définissez-le sur `false` pour conserver tout fichier existant portant le même nom et ajouter un message d’erreur au journal.
`CheckRules( )` *	Vérifie toutes les règles du document. Des autorisations d’écriture sur le document sont requises.
`Field( name : string ) : IField` *	Permet d’accéder à un champ du document à l’aide de son chemin complet. Des chemins complets sont utilisés. Il s’agit d’un champ interne qui nécessite le chargement de l’objet en mémoire. Ne peut pas être utilisé dans les règles.
`HasField( name : string ) : bool` *	Vérifie l’existence d’un champ au chemin spécifié. Des chemins relatifs sont utilisés. Il s’agit d’un champ interne qui nécessite le chargement de l’objet en mémoire. Ne peut pas être utilisé dans les règles.
`IndexedItemValue( name : string ) : VARIANT` *	Récupère la valeur d’un champ à partir de son nom ou de son chemin. Disponible depuis les champs externes des documents et des pages. Vous pouvez utiliser un nom de champ ou un chemin complet vers le champ. Ne peut pas être utilisé dans les règles.
`IndexedItemValues( name : string ) : IVARIANTArray` *	Récupère un jeu de valeurs d’index correspondant à un champ de la définition de document à partir de son nom ou de son chemin. Si un champ est marqué comme champ d’indexation dans une section répétée, la méthode renvoie toutes les valeurs de ce champ dans toutes les sections. Disponible depuis les champs externes des documents et des pages. Vous pouvez utiliser un nom de champ ou un chemin complet vers le champ. Ne peut pas être utilisé dans les règles.
`Property( name : string ) : VARIANT`	Récupère la valeur d’une propriété spécifiée à partir de son nom. La valeur renvoyée peut être une string, un nombre ou une heure. Pour obtenir la liste des noms de propriétés, consultez Noms des propriétés du document.
`SaveAs( filename : string, [optional] options : IExportImageSavingOptions )` *	Enregistre l’image d’un document d’une ou 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 champ interne qui nécessite le chargement de l’objet en mémoire.
`SaveAsStream( [optional] options : IExportImageSavingOptions ) : byte[]` *	Enregistre le document dans un flux en mémoire et le renvoie sous forme de tableau d’octets (COM SafeArray). JScript et VBScript ne prennent pas en charge l’itération sur ce tableau.
`SaveXmlToFile( filename : string )` *	Enregistre à l’emplacement spécifié le fichier XML contenant la description du document sans prétraitement, afin de l’utiliser dans Web Verification Station.
`SaveXmlToFileStorage( )` *	Enregistre dans le stockage de fichiers le fichier XML contenant la description du document sans prétraitement, afin de l’utiliser dans Web Verification Station.

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.

Propriétés

Nom	Type	Accès	Description
Action *	IActionResult	Lecture seule	Disponible uniquement dans les scripts d’exportation et de post-exportation.
AsBatchItem *	IBatchItem	Lecture seule	Convertit le document en objet IBatchItem.
AssemblingErrors	IAssemblingErrors	Lecture seule	Collection d’erreurs d’assemblage. L’accès à cette collection est toujours en lecture seule.
Attachments	IUserAttachments	Lecture seule	Pièces jointes de l’utilisateur.
Batch	IBatch	Lecture seule	Le batch. Quels que soient les droits du script sur le document, l’accès au batch est en lecture seule et les champs internes des documents et des pages ne sont pas disponibles.
BatchName	string	Lecture seule	Le nom du batch.
Children *	IFields	Lecture seule	Champs enfants (sections du document). Contrairement à la propriété `Sections`, 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, dont les instances sont accessibles via la méthode `Items`. Il s’agit d’un champ interne qui nécessite le chargement de l’objet en mémoire. Ne peut pas être utilisé dans les règles.
Comment	string	Lecture/écriture	Commentaire du document.
DefinitionName	string	Lecture seule	Nom de la Document Definition. Pour les documents non traités et non reconnus, la propriété renvoie une chaîne vide.
DocumentDefinition	IDocumentDefinitionInfo	Lecture seule	Informations détaillées sur la Document Definition associée au document.
HasErrors	bool	Lecture seule	Indique si le document présente des erreurs de champ unique ou de champs multiples.
HasUnpreparedImages	bool	Lecture seule	Indique si le document contient des pages non prétraitées.
HasWarnings	bool	Lecture seule	Indique si le document présente des avertissements de règle ou de format.
Id	string	Lecture seule	Identifiant du document (External Id). Sa valeur commence à 1 et n’est unique qu’au sein d’un même batch.
Index	int	Lecture seule	Indice du document dans le batch. Sa valeur commence à 0 et n’est unique qu’au sein d’une même tâche.
IsAnalyzed	bool	Lecture seule	Indique si le document est analysé. Un document est considéré comme analysé lorsque toutes ses pages le sont.
IsAssembled	bool	Lecture seule	Indique si le document est assemblé.
IsExcludedFromAutomaticAssembling	bool	Lecture/écriture	Indique si le document est inclus dans l’assemblage automatique.
IsExported	bool	Lecture seule	Indique si le document est exporté.
IsRecognized	bool	Lecture seule	Indique si le document est reconnu. Un document est considéré comme reconnu lorsque chacune de ses pages est reconnue ou constitue une page annexe.
IsUsedForTraining	bool	Lecture/écriture	Indique si le document est utilisé pour l’entraînement.
IsVerified	bool	Lecture seule	Indique si le document est vérifié.
Pages	IPages	Lecture seule	Pages du document.
PreviousStageInfo *	IStageInfo	Lecture seule	Renvoie l’objet IStageInfo, c’est-à-dire les informations sur l’étape de traitement du document. Les champs `TaskId` et `PrincipalId` ne sont pas utilisés.
Priority	TProcessingPriority	Lecture seule	Priorité du document.
ProcessingErrors *	string	Lecture seule	Erreurs de traitement séparées par des sauts de ligne.
ProcessingWarnings *	string	Lecture seule	Avertissements de traitement séparés par des sauts de ligne.
ProhibitedUserId *	int	Lecture seule	Une tâche créée à partir du document n’est pas accessible à l’utilisateur ayant l’identifiant spécifié. Par défaut, la valeur est `0`, ce qui signifie que la tâche est accessible à tous les utilisateurs.
Properties	IProperties	Lecture seule	Paramètres d’enregistrement du document.
RecognizedSymbolsCount *	int	Lecture seule	Nombre de symboles reconnus.
RuleErrors *	IRuleErrors	Lecture seule	Collection d’erreurs du document (erreurs de format, erreurs de règle, erreurs lors de la fusion des résultats de double vérification). Disponible uniquement pour les documents ouverts.
Sections *	IFields	Lecture seule	Liste à plat des sections du document. En présence d’une section récurrente, la liste contient toutes ses occurrences. Les sections sont répertoriées dans le même ordre que les premières pages des sections du document. Les sections sans pages figurent à la fin de la liste. Il s’agit d’un champ interne qui nécessite le chargement de l’objet en mémoire. Ne peut pas être utilisé dans les règles.
StageInfo	IStageInfo	Lecture seule	Informations sur l’étape de traitement sur le serveur d’applications.
SymbolsForVerificationCount	int	Lecture seule	Nombre de symboles nécessitant une vérification.
TotalSymbolsCount	int	Lecture seule	Nombre total de symboles.
UncertainSymbolsCount	int	Lecture seule	Nombre de symboles incertains.

Noms des propriétés du document

La méthode Property récupère les valeurs des propriétés suivantes :

Nom	Valeur renvoyée
`Exported`	Date d’exportation du document
`ExportedBy`	Personne ayant exporté le document
`Created`	Date de création du document
`CreatedBy`	Personne ayant créé le document
`Recognized`	Date de reconnaissance du document
`RecognizedBy`	Personne ayant reconnu le document
`Modified`	Date de la dernière modification du document
`ModifiedBy`	Personne ayant modifié le document
`TotalSymbolsCount`	Nombre total de symboles
`UncertainSymbolsCount`	Nombre total de symboles incertains
`RecognizedSymbolsCount`	Nombre de symboles reconnus
`Comment`	Commentaire du document
`ProcessingErrors`	Erreurs de traitement des documents
`ProcessingWarnings`	Avertissements de traitement des documents
`Verified`	Date et heure de la dernière modification manuelle des champs du document
`VerifiedBy`	Utilisateur ayant effectué les dernières modifications manuelles des champs du document (ne conserve pas les informations des Processing Stations)