IBatch

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 cette page. Dans le paramètre targetPosition, spécifiez l’indice du nouveau document dans le batch. L’indice doit être un nombre compris entre 0 et N, N étant le nombre total de documents dans le batch.

Lorsque la méthode CreateDocumentFromPage est appelée :

• Les documents dont les indices vont de 0 à targetPosition – 1 restent à leur position d’origine.
• Les documents dont les indices vont de targetPosion à N sont décalés d’une position.
• Le nouveau document est placé à la position targetPosition ainsi libérée.

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

CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage *

Crée une page à partir de l’objet IPictureObject et renvoie 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 seule page, spécifiez null comme document cible.
• Si une position est spécifiée, la page est ajoutée à la position spécifiée dans le document (si un document cible est spécifié). Sinon, un document d’une seule page est ajouté à la position spécifiée dans le lot (si 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 depuis IPictureObject.

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, int targetPageIndex : int ) *

Déplace la page d’indice sourcePageIndex du document source à la position targetPageIndex dans le document cible.

AsBatchItem *

IBatchItem

Lecture seule

Convertit le batch en un objet IBatchItem.

Pièces jointes

IUserAttachments

Lecture seule

Pièces jointes de l’utilisateur.

BatchTypeName

string

Lecture seule

Le nom du type de lot.

Commentaire

string

Lecture/écriture

Commentaire.

CreatedBy

IPrincipal

Lecture seule

L’auteur du lot qui vient d’être créé.

Pour la version autonome de FC, renvoie null.

CreationDate

DateTime

Lecture seule

L’heure à laquelle le lot a été créé.

Documents

IDocuments

Lecture seule

Documents composant le lot

ID

int

Lecture seule

L’identifiant du batch (unique au sein du projet).

Name

string

Lecture/écriture

Le nom du batch.

Priorité

TProcessingPriority

Lecture/écriture

La priorité du lot.

Projet

IProject

Lecture seule

Le projet contenant le lot.

Propriétés

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 de début du traitement du lot.

SlaWarningPeriod *

Int

Lecture/écriture

L’heure de début de la période durant laquelle un avertissement signalant l’approche de l’échéance de la tâche s’affiche. Exprimée en nombre de minutes restantes avant l’échéance.

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.