AltoExportParams Object (IAltoExportParams Interface)
This object provides functionality for tuning parameters of recognized text export to ALTO format by means of ABBYY FineReader Engine export functions. This format is mainly used by electronic libraries.
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.
The AltoExportParams object is a persistent object. This means that the object's current state can be written to persistent storage: an area in the global memory or a disk file. Later, the object can be re-created by reading the object's state from persistent storage. The following methods provide persistence of the object: SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.
Properties
| Name | Type | Description |
|---|---|---|
| Application | Engine, read-only | Returns the Engine object. |
| FontFormattingMode | FontFormattingModeEnum |
Specifies which font attributes are to be written into files in ALTO format. The default value of this property is FAM_Plain, which means that the only saved attribute is whether a character is subscript or superscript. |
| AltoVersion | AltoVersionEnum |
Specifies the value of the exported document format version. The default value of this property is AV_Version_20, which means that the ALTO document is exported in 2.0 version. |
| WriteNondeskewedCoordinates | VARIANT_BOOL |
Specifies whether character, word, block coordinates written into files in ALTO format should be defined on an original image or on an image used for recognition (to which different modifications, e.g., deskewing, were applied). This property is TRUE by default, which means that the coordinates are defined on an original image.
This is because ALTO format requires the base line position to be described by only one number. In the original coordinates the base line may not be strictly horizontal/vertical, in which case it is impossible to define its position by a single number. |
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 | Restores the object contents from the global memory. |
| SaveToFile | Saves the object contents into a file on disk. |
| SaveToMemory | Saves the object contents into the global memory. |
Output parameter
This object is the output parameter of the CreateAltoExportParams 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
Samples
The object is used in the following code samples: CommandLineInterface.
See also
17.09.2024 15:14:41