XPSExportParams Object (IXPSExportParams Interface)

XPSExportParams object (IXPSExportParams interface) in the ABBYY FineReader Engine API — Tunes export of recognized text to XPS format; persistent object savable to file/memory.

This object provides functionality for tuning of parameters of recognized text export to XPS format by means of ABBYY FineReader Engine export functions.

A pointer to this object is passed into the export methods as an input parameter, affecting the results of export. All properties of a newly created object of this type are set to reasonable defaults. For information about the default value of any specific property, see the description of that property.

The XPSExportParams 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.
Common settings
TextExportMode	XPSExportModeEnum	Specifies the mode of export to XPS format. The default value of this property is XEM_ImageOnText.
PaperSizeParams	PaperSizeParams, read-only	Specifies paper height and width.
MetaDataWritingParams	DocumentContentInfoWritingParams, read-only	Specifies if the author, subject, title, and keywords of the document should be written into the output XPS file. These parameters of the document are defined in the DocumentContentInfo subobject of the FRDocument object.
Pictures export
PictureExportParams	PictureExportParams, read-only	Specifies the image format and JPEG quality which should be used during export.

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.

Related objects

Object Diagram

Output parameter

This object is the output parameter of the CreateXPSExportParams 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

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