Document - ABBYY Documentation

Le type de données Document stocke des informations sur un document.

Champs

Nom	Type	Description
`Id`	`int`	ID d’un document. La seule façon d’attribuer un ID à un document consiste à utiliser la méthode GetBatchIdsRange, qui réserve des ID pour les nouveaux documents. Attribuez un ID à un document avant de l’ajouter à un lot. Un ID de document est généré automatiquement si vous définissez sa valeur sur `-1`.
`BatchId`	`int`	ID du lot.
`ParentId`	`int`	ID du document parent du jeu. Si un nouveau document fait partie d’un jeu, attribuez à ce champ l’ID du document parent du jeu. Si un nouveau document ne fait partie d’aucun jeu, définissez la valeur du champ sur `0`. Créez le document parent avant de créer les documents enfants.
`ChildrenOrder`	ChildrenOrder[]	Un jeu de documents enfants permettant de trier les documents du jeu. Lorsque les données sont lues depuis le serveur, ce champ est renseigné automatiquement. S’il est vide, les documents du jeu sont disposés dans l’ordre dans lequel ils ont été ajoutés.
`DocIndex`	`int`	Indice du document.
`TemplateName`	`string`	Nom de la définition de document.
`ProcessingStageType`	`int`	Type de l’étape de traitement. Pour connaître les valeurs possibles, consultez ProcessingStageType.
`Comment`	`string`	Commentaire sur le document.
`Pages`	Page[]	Jeu de pages du document.
`IsProcessed`	`bool`	Indicateur signalant si le document a été traité.
`HasProcessingErrors`	`bool`	Indicateur signalant la présence d’erreurs de traitement.
`HasDocumentErrors`	`bool`	Indicateur signalant la présence d’erreurs dans le document (par exemple, des erreurs de format, de règle ou d’assemblage).
`ErrorText`	`string`	Description des erreurs de traitement du document.
`ExternalId`	`string`	ID externe du document.
`Properties`	RegistrationProperty[]	Jeu de paramètres d’enregistrement du document.
`Priority`	Priority[]	Priorité du document.
`FileVersion`	`int`	Version du fichier document sur le serveur.
`OwnerId`	`int`	ID de l’utilisateur ou du groupe propriétaire du projet.
`StageExternalId`	`int`	ID de l’étape de traitement lors de laquelle la tâche a été créée (unique au sein du type de lot).
`TaskId`	`int`	ID de la tâche à laquelle appartient le document.
`UncertainSymbols`	`int`	Nombre de caractères incertains.
`VerificationSymbols`	`int`	Nombre de caractères vérifiés.
`TotalSymbols`	`int`	Nombre total de caractères du document.
`HasErrors`	`bool`	Indicateur signalant la présence d’erreurs de règle de validation.
`HasWarnings`	`bool`	Indicateur signalant la présence d’avertissements liés aux règles de validation.
`HasAssemblingErrors`	`bool`	Indicateur signalant la présence d’erreurs d’assemblage.
`HasAttachments`	`bool`	Indicateur signalant si le document comporte des pièces jointes.
`Flags`	`int`	Ensemble d’indicateurs décrivant l’état du document. La valeur combine les indicateurs répertoriés après ce tableau.

Valeurs du champ Flags

La valeur Flags est une combinaison des indicateurs suivants. Seuls les indicateurs utiles pour travailler avec les tâches et les méthodes de l’API Web Services sont répertoriés.

Indicateur	Valeur	Signification
`BIF_IsAnalyzed`	`0x100`	Le document est analysé.
`BIF_IsRecognized`	`0x200`	Le document est reconnu.
`BIF_IsVerified`	`0x400`	Le document est vérifié.
`BIF_IsExported`	`0x800`	Le document est exporté.
`BIF_HasRuleErrors`	`0x10000`	Le document contient des erreurs d’exécution des règles.
`BIF_HasRuleWarnings`	`0x20000`	Le document contient des avertissements d’exécution des règles.
`BIF_HasMergeVersionErrors`	`0x80000`	Le document contient des erreurs lors de la fusion des résultats de la double vérification (les résultats de vérification ne correspondent pas).
`BIF_HasUserAttachments`	`0x100000`	Le document comporte des pièces jointes.
`BIF_HasUnmatchedFieldErrors`	`0x200000`	Le document contient des champs non mis en correspondance.
`BIF_NeedsPreprocessing`	`0x800000`	Le document nécessite un prétraitement.
`BIF_IsManuallyCreated`	`0x1000000`	Le document a été créé manuellement.
`BIF_IsExcludedFromAutomaticAssembling`	`0x2000000`	Le document est exclu de l’assemblage automatique.
`BIF_IsSourceImageAttached`	`0x4000000`	Un fichier image source est joint au document.