French (Français)

IBatch

Effet produit

Représente le lot.

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

Important !Pour les méthodes ci-dessous, les autorisations permettant de modifier la structure du lot sont requises. Ces méthodes peuvent uniquement être appelées à partir du script traitement de lot.

Définition Description
CleanRecognitionResults( document : IDocument ) * Efface les résultats de reconnaissance du document.
CreateDocumentFromPage( targetPosition :entier, page : IPage ): IDocument *

Prend une page du document et crée un nouveau document à partir de cette page. Dans le paramètre targetPosition, spécifiez un index pour le nouveau document du lot. L'index doit être un nombre compris entre 0 et N, N étant le nombre total de documents du lot.

Lorsque la méthode CreateDocumentFromPage est appelée :

  • Les documents contenant des index à partir de 0 jusqu'à targetPosition – 1 resteront dans leur position d'origine.
  • Les documents contenant des index à partir de targetPosion jusqu'à N seront déplacés d'une position vers l'avant.
  • Le nouveau document sera placé dans la targetPosition laissée vacante.

Remarque : Si, après la suppression de la page, le document est vide, il sera supprimé.

Exemple
CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : entier, [optional] sourceInfo : chaîne ) : IPage *

Crée une page à partir de l'objet IPictureObject et retourne la page créée.

  • Si un document cible est spécifié, la page est ajoutée à ce document. Pour créer un document d'une page, spécifiez null comme document cible.
  • Si une position est spécifiée, la page est ajoutée à cette position dans le document (si un document cible est spécifié). Sinon, un document d'une page est ajouté à la position spécifiée du lot (si null est spécifié comme document cible). La position initiale correspond à la valeur "0", la fin du document ou du lot correspond à « -1 ».
  • Si le paramètre "sourceInfo" est spécifié, il est écrit dans les informations de la page source. Sinon, des informations sur la source de la page sont reçues par IPictureObject.
DeleteDocument( document : IDocument ) * Supprime le document.
DeletePage( page : IPage ) * Supprime la page.
MoveDocument( source : IDocument, targetPosition :entier ) * Déplace le document vers une position spécifique dans le lot.
MovePage( source : IDocument, target : IDocument, sourcePageIndex : entier, int targetPageIndex : entier ) * Déplace la page portant l'indice "sourcePageIndex" à partir du document "source" vers le document "target" à la position "targetPageIndex".

Propriétés

Nom Type Accès Description
AsBatchItem * IBatchItem Lecture/écriture Convertit le lot en un objet IBatchItem.
Attachments IUserAttachments Lecture seule Pièces jointes de l'utilisateur
BatchTypeName chaîne Lecture seule Le nom du type de lot
Comment chaîne Lecture/écriture Le commentaire
CreatedBy IPrincipal Lecture seule

L'auteur du lot nouvellement créé.
CreationDate DateTime Lecture seule L'heure à laquelle le lot a été créé.
Documents IDocuments Lecture seule Renseigne sur la composition du lot.
Id entier Lecture seule L'identificateur de lot (unique dans le projet).
Name chaîne Lecture/écriture Nom du lot
Priority TProcessingPriority Lecture/écriture La priorité du lot
Project IProject Lecture seule Le 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 L'heure à laquelle le traitement du lot a commencé.
SlaWarningPeriod * Int Lecture/écriture Heure de début de la période au cours de laquelle un avertissement relatif à l'approche de l'échéance de la tâche sera affiché. Indiquée sous forme de minutes restant jusqu'à l'échéance.
StageInfo IStageInfo Lecture seule Retourne l'objet IStageInfo avec des informations sur l'étape de traitement du document. Les champs TaskId et PrincipalId ne sont pas utilisés.

12.04.2024 18:16:03

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.