IBatch - ABBYY Documentation

Repräsentiert den Batch.

Einige Methoden und Eigenschaften dieses Objekts stehen auf der Web-Verifizierungsstation für die lokale Prüfung von Regeln nicht zur Verfügung. Die nicht unterstützten Methoden und Eigenschaften sind mit einem Sternchen (*) gekennzeichnet.

Methoden

Für die folgenden Methoden sind Berechtigungen zum Ändern der Batchstruktur erforderlich. Sie können nur im Skript Batchverarbeitung aufgerufen werden.

Methode	Beschreibung
`CleanRecognitionResults( document : IDocument )` *	Löscht die Erkennungsergebnisse für das Dokument.
`CreateDocumentFromPage( targetPosition : int, page : IPage ) : IDocument` *	Entnimmt dem Dokument eine Seite und erstellt daraus ein neues Dokument. Geben Sie im Parameter `targetPosition` den Index des neuen Dokuments im Batch an. Der Index muss eine Zahl zwischen 0 und N sein, wobei N die Gesamtzahl der Dokumente im Batch ist. Weitere Informationen finden Sie unter Ein Dokument aus einer Seite erstellen.
`CreatePageFromImage( page : IPictureObject, [optional] target : IDocument, [optional] position : int, [optional] sourceInfo : string ) : IPage` *	Erstellt eine Seite aus einem IPictureObject-Objekt und gibt die erstellte Seite zurück. Weitere Informationen finden Sie unter Eine Seite aus einem Bild erstellen.
`DeleteDocument( document : IDocument )` *	Löscht das Dokument.
`DeletePage( page : IPage )` *	Löscht die Seite.
`MoveDocument( source : IDocument, targetPosition : int )` *	Verschiebt das Dokument an die angegebene Position im Batch.
`MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, targetPageIndex : int )` *	Verschiebt die Seite mit dem Index `sourcePageIndex` aus dem Quelldokument an die Position `targetPageIndex` im Zieldokument.

Ein Dokument aus einer Seite erstellen

Die Methode CreateDocumentFromPage entnimmt dem Dokument eine Seite und erstellt daraus ein neues Dokument. Geben Sie den Index für das neue Dokument im Parameter targetPosition an. Der Index muss eine Zahl zwischen 0 und N sein, wobei N die Gesamtzahl der Dokumente im Batch ist. Beim Aufruf der Methode:

Die Dokumente mit Indizes von 0 bis targetPosition - 1 bleiben an ihren ursprünglichen Positionen.
Die Dokumente mit Indizes von targetPosition bis N rücken um eine Position nach vorne.
Das neue Dokument wird an der frei gewordenen Position targetPosition eingefügt.

Wenn das Dokument nach dem Entfernen der Seite leer ist, wird es gelöscht. Im folgenden Beispiel wird das erste Dokument verarbeitet:

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

Eine Seite aus einem Bild erstellen

Die Methode CreatePageFromImage erstellt aus einem IPictureObject-Objekt eine Seite und gibt diese zurück:

Wenn ein Zieldokument angegeben ist, wird die Seite diesem Dokument hinzugefügt. Um ein einseitiges Dokument zu erstellen, geben Sie null als Zieldokument an.
Wenn eine Position angegeben ist, wird die Seite an der angegebenen Position im Dokument eingefügt (wenn ein Zieldokument angegeben ist). Andernfalls wird ein einseitiges Dokument an der angegebenen Position im Batch eingefügt (wenn null als Zieldokument angegeben ist). Die Startposition entspricht 0, das Ende des Dokuments oder Batches -1.
Wenn der Parameter sourceInfo angegeben ist, wird er in den Informationen zur Seitenquelle gespeichert. Andernfalls werden die Informationen zur Seitenquelle aus dem IPictureObject-Objekt übernommen.

Eigenschaften

Name	Typ	Zugriff	Beschreibung
AsBatchItem *	IBatchItem	Schreibgeschützt	Wandelt den Batch in ein IBatchItem-Objekt um.
Attachments	IUserAttachments	Schreibgeschützt	Benutzeranhänge.
BatchTypeName	string	Schreibgeschützt	Der Name des Batch-Typs.
Comment	string	Lesen/Schreiben	Der Kommentar.
CreatedBy	IPrincipal	Schreibgeschützt	Der Ersteller des neu angelegten Batches. Gibt in der Standalone-Version von ABBYY FlexiCapture `null` zurück.
CreationDate	DateTime	Schreibgeschützt	Der Zeitpunkt, zu dem der Batch erstellt wurde.
Documents	IDocuments	Schreibgeschützt	Die im Batch enthaltenen Dokumente.
Id	int	Schreibgeschützt	Der Batch-Bezeichner (innerhalb des Projekts eindeutig).
Name	string	Lesen/Schreiben	Der Name des Batches.
Priority	TProcessingPriority	Lesen/Schreiben	Die Priorität des Batches.
Project	IProject	Schreibgeschützt	Das Projekt, das den Batch enthält.
Properties	IProperties	Schreibgeschützt	Benannte Parameter des Batches.
SLAExpirationDate	DateTime	Lesen/Schreiben	Verarbeitungsfrist des Batches.
SlaStartDate	DateTime	Schreibgeschützt	Der Zeitpunkt, zu dem die Verarbeitung des Batches begonnen hat.
SlaWarningPeriod *	Int	Lesen/Schreiben	Der Startzeitpunkt des Zeitraums, in dem eine Warnung angezeigt wird, dass die Frist der Aufgabe näher rückt. Angegeben als verbleibende Minuten bis zur Frist.
StageInfo	IStageInfo	Schreibgeschützt	Gibt das IStageInfo-Objekt mit Informationen zur Verarbeitungsstufe des Dokuments zurück. Die Felder `TaskId` und `PrincipalId` werden nicht verwendet.

​Methoden

​Ein Dokument aus einer Seite erstellen

​Eine Seite aus einem Bild erstellen

​Eigenschaften

Methoden

Ein Dokument aus einer Seite erstellen

Eine Seite aus einem Bild erstellen

Eigenschaften