XMLExportParams-Objekt (IXMLExportParams-Schnittstelle)

XMLExportParams-Objekt (IXMLExportParams-Schnittstelle) in der ABBYY FineReader Engine API — Konfiguriert den Export von erkanntem Text ins XML-Format gemäß dem Schema ABBYY_Scheme_XML.xsd; persistentes Objekt, das in Datei oder Speicher gespeichert werden kann.

Dieses Objekt bietet Funktionen zum Konfigurieren der Parameter für den Export von erkanntem Text im XML-Format. Ein Zeiger auf dieses Objekt wird den Exportmethoden als Eingabeparameter übergeben und wirkt sich dadurch auf die Exportergebnisse aus. Alle Eigenschaften eines neu erstellten Objekts dieses Typs sind standardmäßig auf sinnvolle Vorgabewerte gesetzt. Weitere Informationen zum Standardwert einer bestimmten Eigenschaft finden Sie in der Beschreibung der entsprechenden Eigenschaft.

Sie finden das XML-Schema in der Datei ABBYY_Scheme_XML.xsd.

Diese Datei befindet sich im Ordner Headers für macOS bzw. im Ordner Inc für Linux und Windows (Start > Programme > ABBYY FineReader Engine 12 > Installationsordner > Ordner für Include-Dateien). Eine Beschreibung der XML-Tags finden Sie in der XML Schema Description.

Das XMLExportParams-Objekt ist ein persistentes Objekt. Das bedeutet, dass der aktuelle Zustand des Objekts in einem persistenten Speicher gespeichert werden kann. Später kann das Objekt erneut erstellt werden, indem sein Zustand aus dem persistenten Speicher gelesen wird. Die folgenden Methoden ermöglichen die Persistenz des Objekts:

Linux: SaveToFile und LoadFromFile

Windows SaveToFile, LoadFromFile, SaveToMemory und LoadFromMemory.

​

Eigenschaften

Name	Typ	Beschreibung
Application	Engine, nur lesbar	Gibt das Engine-Objekt zurück.
WriteCharacterRecognitionVariants	VARIANT_BOOL	Gibt an, ob Sammlungen von Varianten der Zeichenerkennung in einer XML-Datei gespeichert werden sollen. Diese Eigenschaft wird nicht berücksichtigt, wenn die Eigenschaft WriteCharAttributes auf XCA_None festgelegt ist. Die Sammlungen können nur dann mehr als ein Element enthalten, wenn die Eigenschaft IRecognizerParams::SaveCharacterRecognitionVariants während der Erkennung auf TRUE gesetzt wurde. Weitere Informationen finden Sie unter Using Voting API. Diese Eigenschaft ist standardmäßig FALSE.
WriteCharAttributes	XMLCharAttributesEnum	Gibt an, welche Zeichenattribute in einer XML-Datei gespeichert werden sollen. Diese Eigenschaft ist standardmäßig XCA_None.
WriteCharFormatting	VARIANT_BOOL	Gibt an, ob Zeichenformatierungen in einer XML-Datei gespeichert werden sollen. Diese Eigenschaft ist standardmäßig FALSE.
WriteNondeskewedCoordinates	VARIANT_BOOL	Gibt an, ob in einer XML-Datei gespeicherte Zeichenkoordinaten auf einer Bildebene ohne Schieflagenkorrektur liegen. Diese Eigenschaft ist standardmäßig TRUE.
WriteParagraphStyles	VARIANT_BOOL	Gibt an, ob Parameter von Absatz- und Schriftstilen in einer XML-Datei gespeichert werden sollen. Dieser Parameter kann nützlich sein, wenn Sie Informationen über Absatzrollen aus XML abrufen möchten. Diese Eigenschaft ist standardmäßig FALSE.
WriteWordRecognitionVariants	VARIANT_BOOL	Gibt an, ob Sammlungen von Varianten der Worterkennung in einer XML-Datei gespeichert werden sollen. Die Sammlungen können nur dann mehr als ein Element enthalten, wenn die Eigenschaft IRecognizerParams::SaveWordRecognitionVariants während der Erkennung auf TRUE gesetzt wurde. Weitere Informationen finden Sie unter Using Voting API. Diese Eigenschaft ist standardmäßig FALSE.

​

Methoden

Name	Beschreibung
CopyFrom	Initialisiert die Eigenschaften des aktuellen Objekts mit den Werten entsprechender Eigenschaften eines anderen Objekts.
LoadFromFile	Stellt den Inhalt des Objekts aus einer Datei auf dem Datenträger wieder her.
LoadFromMemory Hinweis: Nur unter Windows.	Stellt den Inhalt des Objekts aus dem globalen Speicher wieder her.
SaveToFile	Speichert den Inhalt des Objekts in einer Datei auf dem Datenträger.
SaveToMemory Hinweis: Nur unter Windows.	Speichert den Inhalt des Objekts im globalen Speicher.

​

Ausgabeparameter

Dieses Objekt ist der Ausgabeparameter der Methode CreateXMLExportParams des Objekts Engine.

​

Eingabeparameter

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

• die Methoden Export, ExportPages und ExportToMemory des Objekts FRDocument

• die Methode Export des Objekts FRPage

• die Methode RecognizeImageFile des Objekts Engine

• die Methode OnExportPages der Schnittstelle IDocumentViewerEvents für Windows Visual Components

• die Methode OnSendToPages der Schnittstelle IDocumentViewerEvents für Windows Visual Components

​

Beispiele

Das Objekt wird in den folgenden Codebeispielen verwendet: CommandLineInterface (Windows und Linux)

​

Siehe auch

Exportparameter optimieren

Arbeiten mit Profilen

Arbeiten mit Eigenschaften