IBatch

Worum geht es

Repräsentiert den Stapel.

Hinweis. Einige Methoden und Eigenschaften dieses Objekts sind auf der Web-Überprüfungsstation zum lokalen Überprüfen von Regeln nicht verfügbar. Nicht unterstützte Methoden und Eigenschaften sind mit einem Stern (*) markiert.

Methoden

Wichtig! Für die untenstehenden Methoden sind Berechtigungen zum Ändern der Stapelstruktur erforderlich. Diese Methoden können nur über das Skript Stapelverarbeitung aufgerufen werden.

Definition Beschreibung
CleanRecognitionResults( document : IDocument ) * Löscht die Erkennungsergebnisse des Dokuments.
CreateDocumentFromPage( targetPosition : int, page : IPage ): IDocument  *

Parameter targetPosition einen Index für das neue Dokument im Stapel an. Der Index muss eine Zahl zwischen 0 und N sein, wobei N die Gesamtanzahl der Dokumente im Stapel ist.

Bei Aufrufen der Methode CreateDocumentFromPage :

  • Die Dokumente mit den Indexen 0 bis targetPosition – 1 verbleiben in ihren ursprünglichen Positionen.
  • Die Dokumente mit den Indexen von targetPosion bis N werden eine Position nach vorne verschoben.
  • Das neue Dokument wird in der freien targetPosition platziert.

Hinweis. Ist das Dokument leer, nachdem die Seite entfernt wurde, wird es gelöscht.

Beispiel

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.

  • Wurde ein Zieldokument angegeben, wird die Seite diesem Dokument hinzugefügt. Um ein aus einer Seite bestehendes Dokument zu erstellen, geben Sie Null als ein Zieldokument an.
  • Wird eine Position angegeben, wird die Seite der angegebenen Position des Dokuments hinzugefügt (wenn ein Zieldokument angegeben wird). Anderenfalls wird bei der angegebenen Position des Stapels ein aus einer Seite bestehendes Dokument hinzugefügt (wenn Null als Zieldokument angegeben wird). Die Anfangsposition entspricht dem Wert "0" und das Ende des Dokuments oder Stapels entspricht "-1".
  • Wird der Parameter sourceInfo angegeben, wird das in die Informationen der Seitenquelle geschrieben. Anderenfalls erhält man die Informationen über die Seitenquelle von IPictureObject.
DeleteDocument( document : IDocument ) * Löscht das Dokument.
DeletePage( page : IPage ) * Löscht die Seite.
MoveDocument( source : IDocument, targetPosition : int ) * Verschiebt das Dokument zu einer bestimmten Position im Stapel.
MovePage( source : IDocument, target : IDocument, sourcePageIndex : int, int targetPageIndex : int ) * Verschiebt die Seite mit dem Index "sourcePageIndex" vom Dokument "source" zum Dokument "target" an die Position "targetPageIndex".

Eigenschaften

Name Typ Zugriff Beschreibung
AsBatchItem * IBatchItem Schreibgeschützt Konvertiert den Stapel in ein IBatchItem-Objekt.
Attachments IUserAttachments Schreibgeschützt Benutzeranhänge
BatchTypeName string Schreibgeschützt Der Name des Stapeltyps
Comment string Lesen/Schreiben Der Kommentar
CreatedBy IPrincipal Schreibgeschützt

Der Autor des neu erstellten Stapels.

CreationDate DateTime Schreibgeschützt Die Zeit, wann der Stapel erstellt wurde.
Documents IDocuments Schreibgeschützt Dokumente, aus denen der Stapel besteht
Id int Schreibgeschützt Die Stapelkennung. Der Parameter ist innerhalb des Stapels einzigartig.
Name string Lesen/Schreiben Der Name des Stapels
Priority TProcessingPriority Lesen/Schreiben Priorität des Stapels
Project IProject Schreibgeschützt Das Projekt, das den Stapel enthält
Properties IProperties Schreibgeschützt Benannte Parameter des Stapels
SLAExpirationDate DateTime Lesen/Schreiben Verarbeitungstermin des Stapels.
SlaStartDate DateTime Schreibgeschützt Die Uhrzeit, zu der die Verarbeitung des Stapels gestartet wurde.
SlaWarningPeriod * Int Lesen/Schreiben Die Startzeit des Zeitraums, in dem eine Warnung zum bevorstehenden Termin der Aufgabe angezeigt wird. Angegeben in verbleibenden Minuten bis zum Termin.
StageInfo IStageInfo Schreibgeschützt Gibt das Objekt IStageInfo mit Informationen über die Verarbeitungsphase des Dokuments zurück. Die Felder TaskId und PrincipalId werden nicht verwendet.

11/10/2020 12:08:03 PM


Please leave your feedback about this article