IBatch - ABBYY Documentation

Représente le lot.

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 rules. Les méthodes et propriétés non prises en charge sont signalées par un astérisque (*).

Méthodes

Les méthodes suivantes nécessitent l’autorisation de modifier la structure Lot. Elles peuvent être appelées uniquement depuis le script de traitement par lots.

Méthode	Description
`CleanRecognitionResults( document : IDocument )` *	Supprime les résultats de reconnaissance du document.
`CreateDocumentFromPage( targetPosition : int, page : IPage ) : IDocument` *	Prend une page du document et crée un nouveau document à partir de celle-ci. Dans le paramètre `targetPosition`, spécifiez l’indice du nouveau document dans le lot. Cet indice doit être compris entre 0 et N, où N correspond au nombre total de documents du lot. Pour plus d’informations, consultez Créer un document à partir d’une page.
`CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage` *	Crée une page à partir d’un objet IPictureObject et renvoie la page créée. Pour plus d’informations, consultez Créer une page à partir d’une image.
`DeleteDocument( document : IDocument )` *	Supprime le document.
`DeletePage( page : IPage )` *	Supprime la page.
`MoveDocument( source : IDocument, targetPosition : int )` *	Déplace le document à la position spécifiée dans le lot.
`MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, targetPageIndex : int )` *	Déplace la page d’indice `sourcePageIndex` du document source vers la position `targetPageIndex` du document cible.

Créer un document à partir d’une page

La méthode CreateDocumentFromPage prend une page d’un document et crée un nouveau document à partir de celle-ci. Indiquez l’indice du nouveau document dans le paramètre targetPosition. L’indice doit être compris entre 0 et N, où N correspond au nombre total de documents du lot. Lorsque la méthode est appelée :

Les documents dont les indices sont compris entre 0 et targetPosition - 1 conservent leur position d’origine.
Les documents dont les indices sont compris entre targetPosition et N avancent d’une position.
Le nouveau document est placé à la position targetPosition libérée.

Si le document devient vide après le retrait de la page, il est supprimé. L’exemple suivant traite le premier document :

IDocument document = Documents[0];
for( int i = document.Pages.Count - 1; i >= 0; --i ) 
{
    Batch.CreateDocumentFromPage( document.Index + 1, document.Pages[i] );
}

Créer une page à partir d’une image

La méthode CreatePageFromImage crée une page à partir d’un objet IPictureObject et renvoie la page créée :

Si un document cible est spécifié, la page y est ajoutée. Pour créer un document d’une seule page, spécifiez null comme document cible.
Si une position est spécifiée, la page est ajoutée à la position indiquée dans le document (lorsqu’un document cible est spécifié). Sinon, un document d’une seule page est ajouté à la position indiquée dans le lot (lorsque null est spécifié comme document cible). La position initiale correspond à 0 et la fin du document ou du lot correspond à -1.
Si le paramètre sourceInfo est spécifié, il est enregistré dans les informations sur la source de la page. Sinon, les informations sur la source de la page sont récupérées à partir de IPictureObject.

Propriétés

Nom	Type	Accès	Description
AsBatchItem *	IBatchItem	Lecture seule	Convertit le lot en objet IBatchItem.
Attachments	IUserAttachments	Lecture seule	Pièces jointes de l’utilisateur.
BatchTypeName	string	Lecture seule	Nom du type de lot.
Comment	string	Lecture/écriture	Commentaire.
CreatedBy	IPrincipal	Lecture seule	Auteur du lot nouvellement créé. Pour la version Standalone d’ABBYY FlexiCapture, renvoie `null`.
CreationDate	DateTime	Lecture seule	Date et heure de création du lot.
Documents	IDocuments	Lecture seule	Documents qui composent le lot.
Id	int	Lecture seule	Identifiant du lot (unique au sein du projet).
Name	string	Lecture/écriture	Nom du lot.
Priority	TProcessingPriority	Lecture/écriture	Priorité du lot.
Project	IProject	Lecture seule	Projet contenant le lot.
Properties	IProperties	Lecture seule	Paramètres nommés du lot.
SLAExpirationDate	DateTime	Lecture/écriture	Date limite de traitement du lot.
SlaStartDate	DateTime	Lecture seule	Date et heure de début du traitement du lot.
SlaWarningPeriod *	Int	Lecture/écriture	Heure de début de la période durant laquelle un avertissement s’affiche à l’approche de la date limite de la tâche. Exprimée en minutes restantes avant la date limite.
StageInfo	IStageInfo	Lecture seule	Renvoie l’objet IStageInfo, qui contient des informations sur l’étape de traitement du document. Les champs `TaskId` et `PrincipalId` ne sont pas utilisés.

​Méthodes

​Créer un document à partir d’une page

​Créer une page à partir d’une image

​Propriétés

Méthodes

Créer un document à partir d’une page

Créer une page à partir d’une image

Propriétés