FRPage-Objekt (IFRPage-Schnittstelle)

FRPage-Objekt (IFRPage-Schnittstelle) in der ABBYY FineReader Engine API — repräsentiert eine einzelne Seite, entweder aus einem FRDocument oder aus einem Batch Processor (Linux/Windows); stellt Methoden auf Seitenebene für Analyse, Erkennung, Synthese, Export und Vorverarbeitung sowie Operationen mit dem Cache-Wörterbuch bereit.

Dieses Objekt repräsentiert eine Seite.

Unter Linux und Windows kann es sich dabei entweder um eine Seite eines Dokuments oder um eine von Batch Processor erzeugte Seite handeln.

Es stellt eine Reihe von Methoden für die Seitenvorverarbeitung, Analyse, Erkennung, Seitensynthese und den Export bereit. Die Methoden dieses Objekts führen keine Dokumentsynthese durch (mit Ausnahme der Methode Synthesize). Vor dem Exportieren der Ergebnisse müssen Sie ausdrücklich eine Methode aufrufen, die die Dokumentsynthese ausführt. Ausführliche Informationen finden Sie unter Optimierungsparameter für Vorverarbeitung, Analyse, Erkennung und Synthese.

Das FRPage-Objekt ist ein sogenanntes “verknüpfbares Objekt.” Für Visual Basic in FRE für Windows kann es mit WithEvents deklariert werden. Für C++ (alle unterstützten Betriebssysteme) bedeutet dies, dass es die Schnittstelle IConnectionPointContainer unterstützt. Um während der Verarbeitung Benachrichtigungsereignisse zu empfangen, sollten C++-Benutzer ein von der Schnittstelle IFRPageEvents abgeleitetes Objekt erstellen und…

• Unter Linux und macOS dieses mithilfe des Aufrufs der globalen Funktion AdviseFREngineObject beim FRPage-Objekt registrieren.
• Unter Windows: die Verbindung zwischen diesem Objekt und der im FRPage-Objekt implementierten Ereignisquelle mit den Standardmitteln von COM einrichten.

Unter Windows: Die Methoden des FRPage-Objekts melden Informationen über den Fortschritt der Seitenverarbeitung über spezielle ausgehende Schnittstellen. Diese Schnittstellen sind IFRPageEvents (für C++) und die dispinterface DIFRPageEvents (für Visual Basic). Es ist zu beachten, dass sich Visual-Basic-Benutzer nicht um die Details der Implementierung von Ereignisschnittstellen kümmern müssen, da diese Entwicklungsplattform dafür einfache Mittel bereitstellt.

​

Eigenschaften

	, read-only	Gibt das Engine-Objekt zurück.
	, read-only	Gibt das Document zurück, das die Seite enthält.
	, read-only	Ermöglicht den Zugriff auf das Bild der Seite.
		Ermöglicht den Zugriff auf das Layout der Seite. Wenn Sie dieser Eigenschaft ein Layout-Objekt zuweisen (z. B. beim Übertragen von Daten von einer Seite auf eine andere), wird die logische Struktur des entsprechenden Documents ungültig. Die Document-Struktur muss durch den Aufruf einer der Synthesemethoden wiederhergestellt werden. Es ist jedoch nicht erforderlich, die Synthese für das gesamte Document durchzuführen – es genügt, die geänderten Seiten zu synthetisieren, z. B. mit der Synthesize -Methode.
	, read-only	Gibt den Text der Seite in einem speziellen “Nur-Text”-Format zurück.
	, read-only	Gibt den vollständigen Pfad zum Quellbild der Seite an.
	, read-only	Gibt die Hauptsprache der erkannten Seite an. Die Eigenschaft enthält den internen Namen der ersten Sprache in der Sammlung der erkannten Sprachen (Eigenschaft DetectedLanguages). Diese Eigenschaft hat nur dann einen aussagekräftigen Wert, wenn die Erkennung mit aktivierter automatischer Spracherkennung durchgeführt wurde (siehe Eigenschaft für Details). Standardmäßig ist der Wert eine leere Zeichenfolge.
	, read-only	Ermöglicht den Zugriff auf die Sammlung der auf der erkannten Seite festgestellten Erkennungssprachen. Die Sprachen in der Sammlung sind nach Häufigkeit des Vorkommens sortiert: von der am häufigsten bis zur am seltensten vorkommenden. Diese Eigenschaft hat nur dann einen aussagekräftigen Wert, wenn die Erkennung mit aktivierter automatischer Spracherkennung durchgeführt wurde (siehe Eigenschaft für Details). Die Sprachenliste wird nur nach der Erkennung aktualisiert, d. h., wenn Sie das Layout der Seite manuell bearbeiten, bleibt die Sammlung unverändert.
	, read-only	Specifies whether the logical structure of the page is out of date. If this property is TRUE, you should perform document synthesis for the page before export. Otherwise, an error will occur during export. This property is useful when you work with Visual Components. The logical structure of a page becomes invalid if a user changes layout of this page via GUI of Visual Components. If export of such page is performed using commands available in Visual Components, Visual Components synthesize the page automatically. But if you use FineReader Engine API methods for export, you are responsible for performing document synthesis for the page before export.
	, read-only	Returns the index of the page in the source file.
	, read-only	Indicates whether the source file of this page was a digitally signed PDF.
	, read-only	Provides access to the collection of business cards detected on the page.
		Visual Components werden derzeit nur unter Windows unterstützt. Gibt an, ob die Methoden Undo und Redo zulässig sind. Wenn der Wert dieser Eigenschaft TRUE ist, können alle Befehle, die entweder mithilfe von Methoden aufgerufen werden, die die Seite ändern können (z. B. Methoden des FRPage- oder des -Objekts), oder über die Windows Visual Components einem Undo-Stapel hinzugefügt werden. In diesem Fall werden die über die Visual Components aufgerufenen Befehle automatisch zum Stapel hinzugefügt. Um über die API aufgerufene Befehle zum Stapel hinzuzufügen, verwenden Sie die Methode Update. Die Eigenschaft kann für eine Seite, die in Visual Components geöffnet wurde, nicht auf FALSE gesetzt werden.
	, read-only	Visual Components are currently only supported for Windows. Specifies whether the Redo method can be executed for the latest undone command which was called either with the help of one of the methods that can modify the page (such as methods of the FRPage or the object) or from one of the Visual Components.
	, read-only	Visual Components are currently only supported for Windows. Specifies whether the Undo method can be executed for the latest command which was called either with the help of one of the methods that can modify the page (such as methods of the FRPage or the object) or from one of the Visual Components.

​

Methoden

Name	Beschreibung
AddWordsToCacheDictionary	Diese Methode fügt dem Cache-Wörterbuch mehrere Wörter hinzu.
AddWordToCacheDictionary	Diese Methode fügt dem Cache-Wörterbuch ein Wort hinzu.
Analyze	Analysiert die Seite.
AnalyzeRegion	Analysiert das Layout des Bildes in der angegebenen Region.
AnalyzeTable	Ersetzt einen angegebenen Block durch einen Tabellenblock und analysiert die Tabellenstruktur.
CleanCacheDictionary	Diese Methode löscht alle Wörter aus dem Cache-Wörterbuch.
DetectOrientation	Ermittelt die Seitenorientierung.
DetectResolution	Wählt die beste Auflösung aus dem angegebenen Bereich.
Export	Speichert eine Seite in einer Datei in einem externen Format.
ExtractBarcodes	Findet und erkennt alle Barcodeblöcke.
ExtractMrz	Extrahiert Daten aus einer maschinenlesbaren Zone (MRZ).
FindPageSplitPosition	Bestimmt die Position, an der das Bild geteilt werden kann.
Flush	Lädt die dem FRPage-Objekt entsprechenden ImageDocument- und Layout-Objekte aus dem Speicher und speichert sie bei Bedarf auf dem Datenträger, sofern keine Verweise auf sie vorhanden sind. Das Speichern auf dem Datenträger ist optional; Sie können diesen Schritt auslassen, wenn die Daten nicht geändert wurden.
IsEmpty	Prüft, ob die Seite leer ist.
LearnCheckmarks	Trainiert FineReader Engine darauf, Häkchen eines benutzerdefinierten Typs zu erkennen.
PreprocessAnalyzeRecognize	Führt die Vorverarbeitung, Layout-Analyse, Erkennung und Seitensynthese für die Seite durch.
Preprocess	Führt eine Vorverarbeitung der Seite durch: Korrigiert die Seitenorientierung, Invertierung und geometrische Verzerrungen. Die Vorverarbeitung der Seite erfolgt vor der Seitenanalyse.
Recognize	Erkennt die Seite und führt die Seitensynthese durch.
RecognizeBlocks	Erkennt Text und führt die Seitensynthese in einer explizit angegebenen Menge von Blöcken durch.
Redo	Hinweis: Visual Components werden derzeit nur unter Windows unterstützt. Führt den zuletzt rückgängig gemachten Befehl erneut aus, der über die FineReader Engine API aufgerufen wurde.
Synthesize	Führt die Dokumentensynthese für eine einzelne Seite durch. Unter Linux und Windows kann diese Methode bei der Verarbeitung einseitiger Dokumente mit dem Batch Processor nützlich sein.
SynthesizeBusinessCard	Sucht in der angegebenen erkannten Region nach Visitenkartenfeldern.
SynthesizeBusinessCardEx	Versucht, mithilfe der Syntheseparameter Visitenkartenfelder in der angegebenen erkannten Region zu finden.
Undo	Hinweis: Visual Components werden derzeit nur unter Windows unterstützt. Macht den zuletzt über die FineReader Engine API aufgerufenen Befehl rückgängig.
Update	Hinweis: Visual Components werden derzeit nur unter Windows unterstützt. Überträgt Änderungen am Seiten-Layout, die über die FineReader Engine API vorgenommen wurden, an die Visual Components und speichert diese Änderungen im Undo-Stack. Hinweis: Wenn Sie diese Methode aufrufen, wird die logische Struktur des entsprechenden Documents ungültig. Die Document-Struktur muss durch den Aufruf einer der Synthesemethoden wiederhergestellt werden. Es ist jedoch nicht erforderlich, eine Synthese für das gesamte Document durchzuführen – es genügt, nur die geänderten Seiten zu synthetisieren, z. B. mithilfe der Synthesize-Methode.

​

Verwandte Objekte

Objektdiagramm

​

Ausgabeparameter

Dieses Objekt ist der Ausgabeparameter der folgenden Methoden:

• Item-Methode des FRPages-Objekts
• Unter Linux und Windows: GetNextProcessedPage-Methode des BatchProcessor-Objekts

​

Eingabeparameter

Dieses Objekt wird als Eingabeparameter an die folgenden Methoden übergeben:

• IndexOf Methode des Objekts FRPages
• AddPage Methode des Objekts FRDocument
• AddPage Methode des Objekts ExportFileWriter
• CreateObjectFromPage Methode des Objekts ClassificationEngine
• OnProgress, OnWarning, OnRegionProcessed, OnPageProcessed Methoden der Schnittstelle IFRPageEvents
• PageRemoved Methode der Schnittstelle IFRPagesEvents
• ComparePages Methode des Objekts Comparator
• Unter Linux und Windows: ProcessPageAsync Methode des Objekts BatchProcessor
• Unter Windows bei Verwendung von Visual Components:
  • OnActivePageChanged, OnActivePageChanging Methoden der Schnittstelle DocumentViewerEvents
  • OnActivePageChanged, OnActivePageChanging Methoden der Schnittstelle IImageViewerEvents
  • OnActivePageChanged Methode der Schnittstelle IZoomViewerEvents
  • OnActivePageChanged, OnActivePageChanging Methoden der Schnittstelle ITextEditorEvents
  • OnActivePageChanged Methode der Schnittstelle ITextValidatorEvents

​

Verwandte Visual Components

​

Beispiele

C#-Code

FREngine.IEngine engine;
string fileName;
FREngine.IBatchProcessor batchProcessor;
// Es wird vorausgesetzt, dass der Batch Processor erstellt und gestartet wurde
// Erkannte Seiten abrufen und in das PDF-Format exportieren
FREngine.IFRPage page = batchProcessor.GetNextProcessedPage();
while( page != null ) {
 // Seite vor dem Export synthetisieren
 page.Synthesize(null);
 // Seite in eine Datei exportieren
 page.Export(fileName, FREngine.FileExportFormatEnum.FEF_PDF, null);
 page = batchProcessor.GetNextProcessedPage();
}

Das Objekt wird in den folgenden Codebeispielen verwendet:

• macOS: Business Card Recognition und RecognizedTextProcessing
• Linux: BCR, BatchProcessing, CustomLanguage, CommandLineInterface
• Windows: BatchProcessing, CustomLanguage, CommandLineInterface, RecognizedTextProcessing, VisualComponents und Demo-Tools: BatchProcessingRecognition, Engine Predefined Processing Profiles.

​

Siehe auch

FRPages

Arbeiten mit verknüpfbaren Objekten

Arbeiten mit Eigenschaften