Zum Hauptinhalt springen

Was es macht

Die IFlexiCaptureTools-Schnittstelle wird durch ein globales FCTools-Objekt implementiert, das in Skripten verfügbar ist. Alle Methoden des globalen FCTools-Objekts können als statische Methoden aufgerufen werden, zum Beispiel:
FCTools.ShowMessage( "Test" );
Hinweis. Einige Methoden und Eigenschaften dieses Objekts stehen in der Web-Verifizierungsstation für die lokale Prüfung von Regeln nicht zur Verfügung. Nicht unterstützte Methoden und Eigenschaften sind mit einem Sternchen (*) gekennzeichnet.

Methoden

ClassifyPage( page : IPage, [optional] callback : IProcessingCallback, [optional] detectClassesWithoutLayout : bool ) : IPageClassificationResult *

Klassifiziert die Seite und gibt bei erfolgreicher Klassifizierung das Klassifikationsergebnis zurück. Das Klassifikationsergebnis kann der Name einer Klasse aus dem Klassifikator eines Batch-Typs oder null sein.

Diese Methode kann in den folgenden Fällen verwendet werden:

  • Seiten müssen klassifiziert und entsprechend den Klassifikationsergebnissen als durchsuchbare PDFdurchsuchbare PDF in verschiedene Ordner exportiert werden; eine Erkennung oder ein Matching von Dokumentdefinitionen ist nicht erforderlich;
  • Je nach Klassifikationsergebnissen sollen vor der Erkennung bestimmte Aktionen am Dokument durchgeführt werden (z. B. die Korrektur der Seitenausrichtung).

Hinweis: Wenn der Parameter detectClassesWithoutLayout nicht angegeben ist, wird sein Wert auf false gesetzt. Wenn der Wert true ist, basiert die Klassifizierung nur auf Klassen aus einem Klassifikator, und die verfügbaren Dokumentdefinitionen werden für die Klassifizierung nicht verwendet.

Hinweis: Sie können entweder die IProcessingCallback-Schnittstelle verwenden oder eine eigene Schnittstelle implementieren.

IsModuleAllowedByLicense( authorId : string, moduleName : string ) : bool *

Prüft, ob die Lizenz die Verwendung eines Sprachmoduls erlaubt.

LoadImage( filePath : string, [optional] pageNumber : int ) : IEditablePictureObject *

Lädt ein Bild aus einer Datei. Das geladene Bild kann bearbeitet werden. Wenn der Parameter pageNumber nicht angegeben wird, wird sein Wert auf “1.” gesetzt.

NewImageSavingOptions() : IExportImageSavingOptions *

Erstellt ein neues Objekt der Klasse IExportImageSavingOptions.

PictureFromHBitmap( [optional] resolution : int, bitmap : HBITMAP ) : IEditablePictureObject *

Erzeugt ein Bild aus einem HBITMAP-Objekt mit der angegebenen Auflösung. Wenn der Parameter resolution nicht angegeben ist, wird die Bildauflösung automatisch ermittelt. Das erzeugte Bild kann bearbeitet werden.

Hinweis: Da das HBITMAP-Objekt übernommen wird, muss nach dem Erzeugen des Bildes die Methode CloseHandle dafür nicht aufgerufen werden.

Rect( left : int, top : int, right : int, bottom : int ) : string

Erzeugt einen string, der ein Rechteck mit den angegebenen Koordinaten darstellt.

ShowMessage( text : string, [optional] isError : bool )

Zeigt dem Benutzer eine Meldung an. Wenn das Flag isError nicht angegeben ist, wird sein Wert auf false gesetzt. Wenn das Flag isError auf true gesetzt ist, wird eine Fehlermeldung angezeigt, andernfalls eine Benachrichtigung. Wenn das Skript innerhalb eines Verarbeitungsprozesses ausgeführt wird, wird die Meldung im Verarbeitungsprotokoll gespeichert.

Im Gegensatz zu einem Klassifikator dient die Methode ClassifyPage zur Analyse der Seitenklasse, das Klassifizierungsergebnis wird jedoch nicht abgeglichen. Wenn ein Klassifikator beispielsweise die Banking_eng Document Definition nicht enthält, kann die auf die Seite angewendete Methode ClassifyPage einen Abschnitt dieser Document Definition zurückgeben.

Eigenschaften

NameTypZugriffBeschreibung
CurrentUserSession *IUserSessionInfoSchreibgeschütztGibt Informationen über die Sitzung des Benutzers zurück, der aktuell die Processing Station verwendet. Während der Verifizierung gibt sie Informationen über die Sitzung des Benutzers zurück, der die Verifizierung gerade durchführt (einschließlich Remote-Benutzern).
ScriptContext *IScriptDefinitionContextSchreibgeschütztErmöglicht den Zugriff auf das Objekt, in dem das Skript erstellt wurde. Über diese Eigenschaft können Sie auf das Projekt zugreifen, unabhängig von den vom Skript empfangenen Parametern.