FRDocument-Objekt (IFRDocument-Schnittstelle)

FRDocument-Objekt (IFRDocument-Schnittstelle) in der ABBYY FineReader Engine API — Stellt ein Verarbeitungsdokument mit mehreren Seiten dar; Stammelement der FRPages-Sammlung; stellt alle Methoden zur Dokumentverarbeitung auf Dokumentebene bereit (Analyze, Recognize, Synthesize, Export usw.) und ist ein connectable object, das IFRDocumentEvents auslöst.

Dieses Objekt entspricht einem zu verarbeitenden Dokument, das mehrere Seiten enthalten kann. Das FRDocument-Objekt ist das Stammelement einer Sammlung von Dokumentseiten. Jede Seite enthält ein geöffnetes Bild und dessen Layout.

Das FRDocument-Objekt stellt alle erforderlichen Methoden für die Dokumentverarbeitung bereit. Sie können ein Dokument mit nur einer Methode verarbeiten (der Methode Process) oder es schrittweise verarbeiten, indem Sie Analyse, Erkennung, Synthese und Export ausführen. In der Regel sind all diese Schritte in allgemeinen Szenarien der Dokumentverarbeitung erforderlich. Weitere Informationen finden Sie in den Beschreibungen der entsprechenden Methoden. Wenn Sie die Arbeit mit dem FRDocument-Objekt abgeschlossen haben, geben Sie alle von diesem Objekt verwendeten Ressourcen frei (verwenden Sie dazu die Methode Close).

Das Objekt bietet über die Eigenschaft DocumentContentInfo Zugriff auf verschiedene Dokumentattribute wie Autor, Schlüsselwörter, Betreff und Titel.

Das FRDocument-Objekt ist ein sogenanntes „connectable object.“ Für Visual Basic in FRE für Windows kann es mit WithEvents deklariert werden. Für C++ (unter allen unterstützten Betriebssystemen) bedeutet dies, dass es die Schnittstelle IConnectionPointContainer unterstützt. Um während der Verarbeitung Benachrichtigungsereignisse zu empfangen, sollte ein C++-Benutzer ein Objekt erstellen, das von der Schnittstelle IFRDocumentEvents abgeleitet ist, und dann:

• Unter Linux oder macOS das Objekt durch Aufruf der globalen Funktion AdviseFREngineObject an das FRDocument-Objekt anbinden.
• Unter Windows die Verbindung zwischen dem Objekt und der im FRDocument-Objekt implementierten Ereignisquelle mit den Standardmitteln von COM einrichten.

Unter Windows kann das FRDocument-Objekt in Visual Basic außerdem mit WithEvents deklariert werden. Die Methoden des FRDocument-Objekts melden Informationen über den Fortschritt der Seitenverarbeitung über spezielle ausgehende Schnittstellen. Diese Schnittstellen sind IFRDocumentEvents (für C++) und die dispinterface DIFRDocumentEvents (für Visual Basic). Visual-Basic-Benutzer müssen sich nicht um die Details der Implementierung von Ereignisschnittstellen kümmern, da diese Entwicklungsplattform einfache Möglichkeiten zu deren Handhabung bereitstellt.

​

Eigenschaften

	, nur lesbar	Gibt das Engine-Objekt zurück.
	, nur lesbar	Gibt die Größe des dem IFRDocument-Objekt zugewiesenen Speichers zurück. Der Wert dieser Eigenschaft wird in Byte angegeben.
	, nur lesbar	Gibt die Sammlung der Seiten des Documents zurück.
	, nur lesbar	Gibt den Text des Dokuments in einem speziellen “Klartext”-Format aus.
	, nur lesbar	Gibt die Hauptsprache des erkannten Dokuments zurück. 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 bei aktivierter automatischer Spracherkennung durchgeführt wurde (siehe die Eigenschaft für weitere Informationen); andernfalls ist sie ein leerer string.
	, nur lesbar	Ermöglicht den Zugriff auf die Sammlung der im erkannten Dokument erkannten Erkennungssprachen. Die Sprachen in der Sammlung sind nach ihrer Häufigkeit sortiert: von den am häufigsten vorkommenden bis zu den am seltensten vorkommenden. Diese Eigenschaft hat nur dann einen aussagekräftigen Wert, wenn die Erkennung bei aktivierter automatischer Spracherkennung durchgeführt wurde (siehe die -Eigenschaft). Die Sprachliste wird nur nach der Erkennung aktualisiert. Wenn Sie also das Layout des Dokuments manuell bearbeiten, bleibt die Sammlung unverändert.
	, schreibgeschützt	Gibt an, ob die logische Struktur des Dokuments nicht mehr aktuell ist. Wenn diese Eigenschaft TRUE ist, sollten Sie vor dem Export eine Dokumentsynthese durchführen. Andernfalls tritt beim Export ein Fehler auf. Bei der Arbeit mit Visual Components ist diese Eigenschaft hilfreich. Die logische Struktur eines Dokuments wird ungültig, wenn ein Benutzer über die GUI von Visual Components die Reihenfolge oder die Anzahl der Seiten im Dokument ändert. Wenn ein solches Dokument mit den in Visual Components verfügbaren Befehlen exportiert wird, synthetisieren Visual Components das Dokument automatisch. Wenn Sie jedoch FineReader Engine API-Methoden für den Export verwenden, sind Sie dafür verantwortlich, vor dem Export eine Dokumentsynthese durchzuführen. Beachten Sie, dass nicht nur die Dokumentstruktur, sondern auch die Seitenstruktur ungültig werden kann. Daher sollten Sie vor dem Export außerdem prüfen, ob alle Seiten im Dokument eine gültige Seitenstruktur haben (siehe die Eigenschaft IFRPage::PageStructureOutOfDate).
	, nur lesbar	Bietet Zugriff auf die Sammlung der im Dokument erkannten Visitenkarten.
		Enthält Informationen über den Autor, Schlüsselwörter, den Betreff und den Titel des Dokuments und speichert das Wörterbuch mit den Dokumentinformationen.
		Gibt die Sammlung der Anhänge des Dokuments zurück. Diese werden beim Öffnen aus dem eingegebenen PDF-Dokument extrahiert, oder Sie können beim Export eigene Dateien hinzufügen, die an die ausgegebene PDF-Datei angehängt werden. Um alle Dateien dieser Sammlung an die ausgegebene PDF-Datei anzuhängen, setzen Sie die Eigenschaft auf TRUE.
	, nur lesbar	Gibt die Sammlung der Namen von Schriftarten zurück, die aus den Ressourcen der Eingabe-PDF-Datei extrahiert wurden. Wenn das Dokument durch Öffnen einer Datei in einem anderen Format oder aus einer PDF-Datei erstellt wurde, die keine Schriftarten enthält, wird eine leere Sammlung zurückgegeben.
	, nur lesbar	Gibt an, ob mindestens eine der Quelldateien eine digital signierte PDF-Datei war.
		Gibt an, ob die und die Objekte für die entsprechenden Seiten aus dem Speicher entladen und auf dem Datenträger gespeichert werden sollen, wenn keine Referenzen auf diese Objekte vorhanden sind. Unter Linux werden die ImageDocuments und Layouts für nicht verwendete Seiten nicht auf dem Datenträger gespeichert, wenn diese Eigenschaft auf PFP_KeepInMemory gesetzt ist. Der Standardwert dieser Eigenschaft ist PFP_Auto. Unter macOS wird dieser Eigenschaftswert ignoriert. Die ImageDocuments und Layouts für nicht verwendete Seiten werden immer auf dem Datenträger entladen. Für Windows: Um die ImageDocument- und Layout-Objekte für einzelne Seiten des Dokuments aus dem Speicher zu entladen und auf dem Datenträger zu speichern, verwenden Sie für die entsprechenden Seiten die Methode IFRPage::Flush. Der Standardwert dieser Eigenschaft ist PFP_Auto.
		Gibt den Pfad zu dem Ordner an, in dem die temporären Bilddateien im internen Format von ABBYY FineReader Engine gespeichert werden. Standardmäßig hat diese Eigenschaft den Wert “%TEMP%\ABBYY FineReader Engine 12”.

​

Methoden

Name	Beschreibung
AddImageDocument	Fügt dem Dokument ein geöffnetes Bild hinzu, das durch das ImageDocument-Objekt dargestellt wird.
AddImageFile	Öffnet eine Bilddatei und fügt die zur geöffneten Datei gehörenden Seiten dem Document hinzu.
AddImageFileFromAttachment	Öffnet eine Bilddatei aus dem Anhang und fügt die Seiten der geöffneten Datei dem Dokument hinzu.
AddImageFileFromMemory	Öffnet eine Bilddatei aus dem globalen Speicher, in den sie zuvor vom Benutzer geladen wurde, und fügt die Seiten der geöffneten Datei dem Document hinzu.
AddImageFileFromStream	Öffnet eine Bilddatei aus dem vom Benutzer implementierten Eingabestream und fügt die Seiten der geöffneten Datei dem Document hinzu.
AddImageFileWithPassword	Öffnet eine kennwortgeschützte Bilddatei und fügt die Seiten der geöffneten Datei dem Document hinzu.
AddImageFileWithPasswordCallback	Öffnet eine Bilddatei über die IImagePasswordCallback-Schnittstelle und fügt dem Document die Seiten der geöffneten Datei hinzu.
AddPage	Fügt dem Document eine Seite hinzu.
Analyze	Führt eine Layout-Analyse für alle Seiten im Document durch.
AnalyzePages	Führt eine Layout-Analyse für die angegebenen Seiten in einem Dokument durch.
CheckTextLayer	Prüft, ob auf den angegebenen Dokumentseiten eine Textebene vorhanden und zuverlässig ist.
Close	Gibt alle vom FRDocument-Objekt verwendeten Ressourcen frei und versetzt das Objekt in seinen Anfangszustand zurück (wie nach seiner Erstellung mit der Methode IEngine::CreateFRDocument).
ConvertFromOldVersion	Lädt den Inhalt des FRDocument-Objekts, der von früheren Versionen von ABBYY FineReader Engine gespeichert wurde, aus dem angegebenen Ordner.
Export	Speichert das Dokument als Datei in einem externen Format.
ExportPages	Speichert die angegebenen Seiten als Datei in einem externen Format.
ExportToMemory	Speichert das Dokument in einem externen Format im Speicher.
LoadFromFolder	Lädt den von ABBYY FineReader Engine 12 gespeicherten Inhalt des FRDocument-Objekts aus dem angegebenen Ordner.
Preprocess	Führt für alle Seiten im Dokument eine Vorverarbeitung durch: Korrigiert Seitenorientierung, Invertierung und geometrische Verzerrungen und führt bei Bedarf eine Seitentrennung durch.
PreprocessPages	Führt für die angegebenen Seiten im Dokument eine Vorverarbeitung durch: korrigiert die Seitenorientierung, die Invertierung und geometrische Verzerrungen und führt bei Bedarf eine Seitentrennung durch.
Process	Führt die Vorverarbeitung, Layout-Analyse, Erkennung sowie die Seiten- und Dokumentsynthese für alle Seiten im Dokument durch.
ProcessPages	Führt die Vorverarbeitung, Layout-Analyse, Erkennung sowie die Seiten- und Dokumentsynthese für die angegebenen Seiten im Dokument durch.
Recognize	Führt die Erkennung und Seitensynthese für alle Seiten im Dokument durch.
RecognizePages	Führt die Erkennung und die Seitensynthese für die angegebenen Seiten im Document durch.
SaveToFolder	Speichert den Inhalt des FRDocument-Objekts im angegebenen Ordner.
SplitPages	Teilt jede der angegebenen Seiten des Dokuments in mehrere Seiten auf. Diese Methode ist nützlich, wenn es sich bei einer Seite um eine Doppelseite eines Buches handelt oder wenn die Seite Bilder mehrerer Visitenkarten enthält. Die Methode liefert Informationen dazu, wie die Seiten aufgeteilt wurden.
Synthesize	Führt die Dokumentsynthese für alle Seiten des Dokuments durch.
SynthesizePages	Führt die Dokumentsynthese für die angegebenen Seiten des Dokuments durch.

​

Verwandte Objekte

Objektdiagramm

​

Ausgabeparameter

Dieses Objekt ist der Ausgabeparameter der Methoden CreateFRDocument und CreateFRDocumentFromImage des Objekts Engine.

​

Eingabeparameter

Dieses Objekt wird den folgenden Methoden als Eingabeparameter übergeben:

• Methode CreateObjectFromDocument des Objekts ClassificationEngine
• Methode CompareDocuments des Objekts Comparator
• Methode OnDocumentChanged der Schnittstelle IDocumentViewerEvents (für visuelle Komponenten)
• Methode OnDocumentChanged der Schnittstelle ITextValidatorEvents (für visuelle Komponenten)

​

Verwandte visuelle Komponenten

​

Beispiele

C#-Code

FREngine.IEngine engine;
// Dokument erstellen
FREngine.IFRDocument document = Engine.CreateFRDocument();
try {
 // Bilddatei zum Dokument hinzufügen
 document.AddImageFile( "D:\\Demo.tif", null, null );
 // Dokument erkennen
 document.Process( null );
 // Ergebnisse mit Standardparametern als rtf speichern
 document.Export( "D:\\Demo.rtf", FREngine.FileExportFormatEnum.FEF_RTF, null );
}
catch( Exception error )
{
 ...
}
finally {
 // Dokument schließen
 document.Close();
}

C++ (COM)-Code

FREngine::IEnginePtr Engine;
// Dokument erstellen
FREngine::IFRDocumentPtr frDocument = Engine->CreateFRDocument();
try {
 // Bilddatei zum Dokument hinzufügen
 frDocument->AddImageFile( L"D:\\Demo.tif", 0, 0 );
 // Dokument erkennen
 frDocument->Process( 0 );
 // Ergebnisse mit Standardparametern als rtf speichern
 frDocument->Export( L"D:\\Demo.rtf", FREngine::FEF_RTF, 0 );
} catch( _com_error& e ) {
 ...
 // Dokument schließen
 frDocument->Close();
}
// Dokument schließen
frDocument->Close();

Das Objekt wird in fast allen Codebeispielen verwendet; eine Ausnahme ist das BatchProcessing-Codebeispiel für Linux und Windows.

​

Siehe auch

FRPage

IFRDocumentEvents

Parallelverarbeitung mit der ABBYY FineReader Engine

Arbeiten mit verknüpfbaren Objekten

Arbeiten mit Eigenschaften