IFlexiCaptureTools

Worum geht es

Die Schnittstelle IFlexiCaptureTools ist in ein globales FCTools-Objekt implementiert, das in Skripten verfügbar ist. Alle Methoden des globalen FCTools-Objekts können als statische Methoden aufgerufen werden, wie z. B.:

FCTools.ShowMessage( "Test" );
    

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

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

Klassifiziert die Seite und gibt im Fall einer erfolgreichen Klassifizierung das Klassifizierungsergebnis zurück. Das Klassifizierungsergebnis kann der Name der Klasse eines Stapeltypenklassifikators oder Null sein.

Diese Methode kann in folgenden Fällen verwendet werden:

  • die Seiten müssen entsprechend der Klassifizierungsergebnisse als  durchsuchbare PDF klassifiziert und exportiert werden; die Erkennung und Zuordnung der Dokumentdefinitionen ist nicht erforderlich;
  • Je nach Klassifizierungsergebnis sollten manche Schritte mit dem Dokument vor der Erkennung durchgeführt werden (z. B. korrekte Seitenausrichtung).

Hinweis. Wurde der Parameter detectClassesWithoutLayout nicht angegeben, wird sein Wert auf false festgelegt. Ist der Wert true, basiert die Klassifizierung nur auf Klassen eines Klassifikators, und verfügbare Dokumentdefinitionen werden für die Klassifizierung nicht verwendet.

Hinweis. Sie können entweder die Benutzeroberfläche IProcessingCallback verwenden oder Sie implementieren Ihre eigene Benutzeroberfläche.

IsModuleAllowedByLicense( authorId : string, moduleName : string ) : bool * Überprüft, ob das angegebene Modul durch die Lizenz erlaubt ist.
LoadImage( filePath : string, [optional] pageNumber : int ) : IEditablePictureObject * Lädt ein Bild aus einer Datei. Das geladene Bild kann dann bearbeitet werden. Wurde der Parameter pageNumber nicht festgelegt, wird sein Wert auf "1" gesetzt.
NewImageSavingOptions() : IExportImageSavingOptions * Erstellt ein neues Objekt der Klasse IExportImageSavingOptions.
PictureFromHBitmap( bitmap : HBITMAP, [optional] resolution : int ) : IEditablePictureObject *

Erzeugt ein Bild von einem HBITMAP-Objekt mit der angegebenen Auflösung. Wird der Parameter resolution nicht angegeben, wird die Bildauflösung automatisch erkannt. Das generierte Bild kann dann bearbeitet werden.

Beispielcode

Hinweis. Sobald ein HBITMAP in Besitz genommen wurde, ist der Aufruf der Methode CloseHandle nach der Generierung des Bildes nicht erforderlich.

Rect( left : int, top : int, right : int, bottom : int ) : string Erzeugt eine Zeichenfolge in der Form eines Rechtecks mit angegebenen Koordinaten.
ShowMessage( text : string, [optional] isError : bool ) Zeigt dem Benutzer die Nachricht. Wurde das Flag isError nicht festgelegt, wird sein Wert auf false gesetzt. Ist das Flag isError auf true gesetzt, handelt es sich bei der Nachricht um einen Fehler, ansonsten um eine Benachrichtigung. Wird das Skript innerhalb eines Handlingsvorgangs ausgeführt, wird die Nachricht in das Verarbeitungsprotokoll geschrieben.

Hinweis. Im Gegensatz zu einem Klassifikator wird die Methode ClassifyPage zur Analyse der Seitenklasse eingesetzt, aber das Klassifizierungsergebnis wird nicht zugeordnet. Enthält ein Klassifikator beispielsweise nicht die Definition Banking_eng, kann die für die Seite angewendete Methode ClassifyPage einen Bereich dieser Dokumentdefinition zurückgeben..

Eigenschaften

Name Typ Zugriff Beschreibung
CurrentUserSession * IUserSessionInfo Schreibgeschützt Gibt Informationen über die Sitzung des Benutzers zurück, der derzeit die Verarbeitungsstation verwendet. Während der Überprüfung gibt sie Informationen über die Sitzung des Benutzers zurück, der derzeit die Überprüfung durchführt (einschließlich Remote-Benutzer).
ScriptContext * IScriptDefinitionContext Schreibgeschützt Ermöglicht den Zugriff auf das Objekt, in dem das Skript erstellt wurde. Diese Eigenschaft erlaubt Ihnen den Zugriff auf das Projekt unabhängig von den mit dem Skript empfangenen Parametern.

10.11.2020 12:08:03


Please leave your feedback about this article