Document2 - ABBYY Documentation

Description

Le type de données Document2 stocke des informations sur un document. Il contient un ensemble étendu de fields.

Fields

Nom	Type	Description
`Id`	`int`	L’ID du document.
`BatchId`	`int`	L’ID du lot.
`DocIndex`	`int`	Indice du document.
`Pages`	Page2`[]`	L’ensemble des pages du document.
`PageCount`	`int`	Le nombre de pages du document.
`IsProcessed`	`bool`	Indique si le document a été traité. `True` s’il a été traité, `False` sinon.
`HasProcessingErrors`	`bool`	Indique si des erreurs de traitement se sont produites. `True` si des erreurs de traitement se sont produites, `False` sinon.
`HasDocumentErrors`	`bool`	Indique si le document comporte des erreurs, notamment de format, de règle ou d’assemblage. `True` si le document comporte des erreurs, `False` sinon.
`ErrorText`	`string`	Description des erreurs de traitement du document. Renseigné automatiquement par le serveur d’applications.
`ExternalId`	`string`	L’ID externe du document. S’il est laissé vide, ce paramètre est renseigné automatiquement par le serveur d’applications et est identique à `Id`.
`Properties`	RegistrationProperty`[]`	L’ensemble des paramètres d’enregistrement du document.
`PropertiesCount`	`int`	Le nombre de paramètres d’enregistrement.
`Priority`	`int`	Priorité du document. Pour connaître les valeurs possibles, voir ProcessingPriority.
`FileVersion`	`int`	Version du fichier du document sur le serveur. Renseignée automatiquement par le serveur d’applications.
`OwnerId`	`int`	L’ID de l’utilisateur ou du groupe auquel le document est attribué.
`StageExternalId`	`int`	L’ID de l’étape de traitement au cours de laquelle la tâche est créée.
`TaskId`	`int`	L’ID de la tâche à laquelle appartient le document.
`UncertainSymbols`	`int`	Le nombre de caractères incertains.
`VerificationSymbols`	`int`	Le nombre de caractères vérifiés.
`TotalSymbols`	`int`	Le nombre total de caractères.
`HasErrors`	`bool`	Erreurs du document. `True` si le document comporte des erreurs, `False` sinon.
`HasWarnings`	`bool`	Avertissements du document. `True` si le document comporte des avertissements, `False` sinon.
`HasAssemblingErrors`	`bool`	Erreurs d’assemblage du document. `True` si le document comporte des erreurs d’assemblage, `False` sinon.
`HasAttachments`	`bool`	Indique si le document contient 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 de règles.
`BIF_HasRuleWarnings`	`0x20000`	Le document contient des avertissements d’exécution de 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.

⌘I