EBookExportParams Object (IEBookExportParams Interface)
This object provides functionality for tuning of parameters of recognized text export in FB2 and EPUB formats by means of ABBYY FineReader Engine export functions.
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 EBookExportParams 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. |
| Common settings | ||
| TreatFirstPageAsCover | VARIANT_BOOL |
Specifies whether the first page should be treated as a cover during export to FB2 format. If this property is TRUE when saving to EPUB format, the heading of the upper level of the first page is treated as the title of the book. By default, the value of this property is TRUE. |
| FontFormattingMode | FontFormattingModeEnum |
Specifies which font attributes are to be written into files in FB2 or EPUB 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. |
| MetaDataWritingParams | DocumentContentInfoWritingParams, read-only | Specifies if the author, subject, title, and keywords of the document should be written into the output FB2 or EPUB file. These parameters of the document are defined in the DocumentContentInfo subobject of the FRDocument object. |
| Picture embedding | ||
| WritePictures | VARIANT_BOOL |
Specifies whether pictures should be written in the output file. By default, this property is TRUE. |
| PictureExportParams | PictureExportParams, read-only | Specifies the image format and JPEG quality which should be used for embedded pictures in the output file. |
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. |
Related objects
Output parameter
This object is the output parameter of the CreateEBookExportParams 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