XMLExportParams Object (IXMLExportParams Interface)

XMLExportParams object (IXMLExportParams interface) in the ABBYY FineReader Engine API — Tunes export of recognized text to XML format per the ABBYY_Scheme_XML.xsd schema; persistent object savable to file/memory.

This object provides functionality for tuning parameters of recognized text export in XML format. A pointer to this object is passed into the export methods as an input parameter, and thus affects the results of export. All properties of a newly created object of this type are set to reasonable defaults. For more information about the default value of this or that property, see the description of the corresponding property.

You can find the XML schema in the ABBYY_Scheme_XML.xsd file.

This file is located in the Headers folder for macOS or the Inc folder for Linux and Windows (Start > Programs > ABBYY FineReader Engine 12 > Installation Folders > Include Files Folder). For the description of XML tags see the XML Schema Description.

The XMLExportParams object is a persistent object. This means that the object’s current state can be written to persistent storage. Later, the object can be re-created by reading the object’s state from the persistent storage. The following methods provide persistence of the object:

Linux: SaveToFile, and LoadFromFile

Windows SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.

Properties

Name	Type	Description
Application	Engine, read-only	Returns the Engine object.
WriteCharacterRecognitionVariants	VARIANT_BOOL	Specifies if collections of variants of characters recognition are to be written in a file in XML format. This property is not taken into account if the WriteCharAttributes property is XCA\_None. The collections may contain more than one element only if the IRecognizerParams::SaveCharacterRecognitionVariants property was set to TRUE during recognition. See Using Voting API for details. This property is FALSE by default.
WriteCharAttributes	XMLCharAttributesEnum	Specifies which character attributes are to be saved in a file in XML format. This property is XCA\_None by default.
WriteCharFormatting	VARIANT_BOOL	Specifies if character formatting is to be saved in a file in XML format. This property is FALSE by default.
WriteNondeskewedCoordinates	VARIANT_BOOL	Specifies if character coordinates saved in a file in XML format are on a non-deskewed image plane. This property is TRUE by default.
WriteParagraphStyles	VARIANT_BOOL	Specifies whether parameters of paragraph and font styles should be written in a file in XML format. This parameter may be useful, if you want to retrieve information on paragraph roles from XML. This property is FALSE by default.
WriteWordRecognitionVariants	VARIANT_BOOL	Specifies if collections of variants of words recognition are to be written in a file in XML format. The collections may contain more than one element only if the IRecognizerParams::SaveWordRecognitionVariants property was set to TRUE during recognition. See Using Voting API for details. This property is FALSE by default.

Methods

Name	Description
CopyFrom	Initializes properties of the current object with values of similar properties of another object.
LoadFromFile	Restores the object contents from a file on disk.
LoadFromMemory Note: Windows only.	Restores the object contents from the global memory.
SaveToFile	Saves the object contents into a file on disk.
SaveToMemory Note: Windows only.	Saves the object contents into the global memory.

Output parameter

This object is the output parameter of the CreateXMLExportParams method of the Engine object.

Input parameter

This object is passed as the input parameter to the following methods:

• Export, ExportPages, ExportToMemory methods of the FRDocument object

• Export method of the FRPage object

• RecognizeImageFile method of the Engine object

• OnExportPages method of the IDocumentViewerEvents interface for Windows Visual Components

• OnSendToPages method of the IDocumentViewerEvents interface for Windows Visual Components

Samples

The object is used in the following code samples: CommandLineInterface (Windows and Linux)

See also

Tuning Export Parameters

Working with Profiles

Working with Properties