IWorkSpace

Worum geht es

Repräsentiert den Arbeitsbereich der Station. Das Objekt ist in Skripten mit dem Schlüsselwort "this" verfügbar.

Methoden
Definition Beschreibung
AddBatch (target: IWorkspaceItem, name: string, type: IBatchType ):  IWorkspaceItem

Fügt einen Stapel hinzu. Ein neuer Stapel wird nach dem im Parameter target angegebenen Stapel hinzugefügt.

Wenn Sie den Stapel am Anfang der Liste hinzufügen möchten, setzen Sie den Wert des Parameters target „Nothing“:

[VBscript]

me.AddBatch Nothing, "batch 1", me.BatchTypes.Item(0)
          

Wenn der Parameter name leer ist, wird der Stapelname entsprechend den Stapeleinstellungen generiert.

AddDocument (page: IWorkspaceItem, name: string): IWorkspaceItem Fügt die Seite in ein neues Dokument ein. Wenn die Seite bereits im Dokument enthalten ist, werden drei Dokumente erstellt: ein Dokument mit den vorherigen Seiten, ein Dokument mit der aktuellen Seite und ein Dokument mit den nachfolgenden Seiten. Wenn der Parameter Name leer ist, wird der Dokumentname entsprechend den Stapeleinstellungen generiert.
AddPages (fileName: string, target: IWorkspaceItem, [optional] inside: bool): IWorkspaceItems Fügt Seiten aus einer Datei hinzu. Die Seiten können nach dem Element target auf derselben Stufe oder innerhalb des Elements target am Anfange der Liste hinzugefügt werden. Das Ziel kann ein Stapel, ein Dokument oder eine Seite sein. Wenn das Ziel ein Stapel ist, muss der Parameter inside „true“ lauten (die Seiten werden am Anfang des Stapels hinzugefügt). Wenn das Ziel eine Seite ist, muss der Parameter inside „false“ lauten (die Seiten werden nach der angegebenen Seite hinzugefügt). Wenn das Ziel ein Dokument ist, muss der Parameter inside sowohl „true“ als auch „false“ lauten.
ClearSelection () Löscht die aktuelle Auswahl
DeleteItem (item: IWorkspaceItem ) Löscht ein angegebenes Element
DetectPageEmpty (page: IWorkspaceItem, [optional] options: IEmptyPageDetectionOptions ): bool Erkennt eine leere Seite
Exit ( ): bool Beendet die Arbeit der Station
FindPageBarcodes (page: IWorkspaceItem, [optional] options:  IBarcodeFindingOptions ): IScriptFoundBarcodes Sucht nach Barcodes auf der Seite
NewBarcodeFindingOptions ( ): IBarcodeFindingOptions Legt die Optionen zum Auffinden von Barcodes fest
NewEmptyPageDetectionOptions ( ): IEmptyPageDetectionOptions Legt die Optionen zur Erkennung leerer Seiten fest
NewImageSavingOptions ( ): IImageSavingOptions Legt die Bildspeicheroptionen fest
NewPageRect ( ): IPageRect Definiert ein Seitenrechteck
RunScript (scriptName: string, [optional] info: string, [optional] skipShowError: bool): IScriptResult Startet die Skriptausführung
Scan ([optional] folder: string) Startet den Scanvorgang mit Einstellungen des aktuellen Stapeltyps
Send (batch: IWorkspaceItem ) Exportiert den Stapel mit den Einstellungen des aktuellen Stapeltyps
SendByScript (batch: IWorkspaceItem, skipShowExportOptions: bool) Sendet den Stapel mittels Skript mit den Einstellungen des aktuellen Stapeltyps. Der Parameter skipShowExportOptions gibt an, ob das Dialogfeld "Exportoptionen" vor dem Senden des Stapels angezeigt wird.
SendToFC (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) Sendet den Stapel an ABBYY FlexiCapture mit den Einstellungen des aktuellen Stapeltyps. Der Parameter skipShowExportOptions gibt an, ob das Dialogfeld "Exportoptionen" vor dem Senden des Stapels angezeigt wird.
SendToFolder (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) Exportiert den Stapel in einen Ordner mit den Einstellungen des aktuellen Stapeltyps. Der Parameter skipShowExportOptions gibt an, ob das Dialogfeld "Exportoptionen" vor dem Senden des Stapels angezeigt wird.
SendToFTP (batch: IWorkspaceItem, [optional] skipShowExportOptions: bool) Exportiert den Stapel in einen FTP-Ordner mit den Einstellungen des aktuellen Stapeltyps. Der Parameter skipShowExportOptions gibt an, ob das Dialogfeld "Exportoptionen" vor dem Senden des Stapels angezeigt wird..
SetPageImage (page: IWorkspaceItem, fileName: string, [optional] filePageIndex: int) Ändert das Bild der Seite
Wait (millisecond: int) Unterbricht die Skriptausführung für den angegebenen Zeitraum (in Millisekunden)
Eigenschaften
Name Typ Zugriff Beschreibung
ActiveBatch IWorkspaceItem Lesen/Schreiben

Der aktive Stape.

Gibt für einige Event-Skripts (z. B. Bei Senden des Stapels und Bei Stapel gesendet) Null zurück.

Batches IWorkspaceItems Schreibgeschützt Stapel
BatchTypes IBatchTypes Schreibgeschützt Stapeltypen
CurrentBatchType IBatchType Lesen/Schreiben Der aktuelle Stapeltyp
Result IScriptResult Schreibgeschützt Das Ergebnis der Skriptausführung
ScriptEnvInfo string Schreibgeschützt

Umgebungsinformationen über Bedingungen, bei denen das Skript ausgelöst wird.

Bei Skripten, die vor oder nach dem Export automatisch ausgelöst werden, ist der Wert "<exportType> <taskID>". Bei "exportType" kann es sich um einen der Werte "Folder", "FTP", "FC", "RS" oder "Script" handeln und "taskID" ist die Kennung des Export-Tasks.

Bei Skripten, die vor oder nach der Seitenumwandlung automatisch ausgelöst werden, nimmt die Eigenschaft einen der folgenden Werte an: "Rotate <angle>", "FlipHorizontal", "FlipVertical", "Invert", "ConvertToBW", "Deskew", "Despeckle", "Erase <rectLeft> <rectTop> <rectRight> <rectBottom>", "Crop <rectLeft> <rectTop> <rectRight> <rectBottom>", "SplitHorizontal <pos>", "SplitVertical <pos>", "ChangeResolution <newRes>", "Scale <ratio>", "FreeScale <newWidth>, <newHeight>, <newRes>".

ScriptItems IWorkspaceItems Schreibgeschützt

Elemente, für die das Skript aufgerufen wird. Der zurückgegebene Wert ist bei unterschiedlichen Events unterschiedlich.  

Bei den Events Bei Stationsstart und  Bei Schließen der Station ist der zurückgegebene Wert leer.

Bei dem Event Bei abgeschlossenem Scan ist der zurückgegebene Wert eine Liste von Seiten, die während der Scansitzung hinzugefügt wurden.

Bei anderen Events ist der zurückgegebene Wert ein Stapel, ein Dokument oder eine Seite, je nach Event.

Wenn das Skript über einen expliziten Benutzerbefehl aufgerufen wird, wird eine Sammlung aktuell ausgewählter Elemente zurückgegeben.

ScriptProperties IScriptProperties Schreibgeschützt Skripteigenschaften
Selection IWorkspaceItems Schreibgeschützt Die aktuelle Auswahl. Enthält jeweils nur Stapel, nur Dokumente oder nur Seiten.
SourceID string Schreibgeschützt Die Stationskennung

14.01.2021 14:17:18


Please leave your feedback about this article