IBatch

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 einen Index für das neue Dokument im Batch an. Der Index muss eine Zahl zwischen 0 und N sein, wobei N die Gesamtzahl der Dokumente im Batch ist.

Wenn die CreateDocumentFromPage Methode aufgerufen wird:

• Die Dokumente mit Indizes von 0 bis targetPosition – 1 bleiben an ihren ursprünglichen Positionen.
• Die Dokumente mit Indizes von targetPosion bis N werden um eine Position weitergeschoben.
• Das neue Dokument wird an der frei gewordenen targetPosition eingefügt.

Hinweis: Wenn das Dokument nach dem Entfernen der Seite leer ist, wird es gelöscht.

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

Erstellt eine Seite aus dem Objekt IPictureObject und gibt die erstellte Seite 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 Batchs entspricht “-1”.
• Wenn der Parameter sourceInfo angegeben ist, wird er in die Informationen zur Quelle der Seite geschrieben. Andernfalls werden die Informationen zur Quelle der Seite aus IPictureObject übernommen.

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 in der Batch.

MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, int targetPageIndex : int ) *

Verschiebt die Seite mit dem in sourcePageIndex angegebenen Index aus dem Quelldokument an die in targetPageIndex angegebene Position im Zieldokument.

AsBatchItem *

IBatchItem

Schreibgeschützt

Wandelt den Batch in ein IBatchItem-Objekt um.

Anhänge

IUserAttachments

Schreibgeschützt

Anhänge des Benutzers.

BatchTypeName

string

Schreibgeschützt

Der Name des Batch-Typs.

Kommentar

string

Lese-/Schreibzugriff

Der Kommentar.

CreatedBy

IPrincipal

Schreibgeschützt

Der Autor des neu erstellten Batchs.

Für die Standalone-Version von FC wird null zurückgegeben.

CreationDate

DateTime

Schreibgeschützt

Der Zeitpunkt, an dem der Batch erstellt wurde.

Dokumente

IDocuments

Schreibgeschützt

Dokumente im Batch

Id

int

Schreibgeschützt

Der Batch-Bezeichner (innerhalb des Projekts eindeutig).

Name

string

Lese-/Schreibzugriff

Der Name des Batches.

Priorität

TProcessingPriority

Lese-/Schreibzugriff

Die Priorität des Batches.

Projekt

IProject

Schreibgeschützt

Das Projekt, zu dem der Batch gehört.

Eigenschaften

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 Batch begonnen hat.

SlaWarningPeriod *

Int

Lesen/Schreiben

Der Beginn des Zeitraums, in dem eine Warnung vor der nahenden Frist der Aufgabe angezeigt wird. 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.