Properties
| Name | Type | Description |
|---|---|---|
| Application | Engine, read-only | Returns the Engine object. |
| CompressImageMode | CompressImageModeEnum | Specifies if the image should be compressed during conversion to the internal format. Applies only to color and gray images, black and white images are always compressed with lossless compression. By default, this property is set to CIM\_Auto, which currently means that born-digital images (eg. obtained from PDF files) will use lossless, while others images use max compression. |
| DocumentType | DocumentTypeEnum | Specifies the type of the document on the image. If you know the document type for certain, you can set this property to bypass the document classifier and save time. By default, this property is DT\_Auto, which means that FineReader Engine should run the document classifier to determine document type. |
| ImageSourceType | ImageSourceTypeEnum | Specifies the image origin. For example, a photo and a screenshot with some text will need different preprocessing techniques. By default, this property is IST\_Auto, which means that FineReader Engine should detect the image origin automatically. |
| OfficeConversionSettings <Note> Linux and Windows only. </Note> | OfficeConversionSettings, read-only | Provides access to the settings for importing digital documents using the same methods that open the images. |
| RasterizeFreeText <Note> This property is not supported in ABBYY FineReader Engine 12 for macOS . </Note> | VARIANT\_BOOL | Specifies whether Free Text annotations from the input PDF document should be retained. By default, this property is set to TRUE. <Warning> In Linux , before using this property, make sure the Arial or Liberation Sans font is available on your workstation. </Warning> |
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. </Note> | Restores the object contents from the global memory. |
| SaveToFile | Saves the object contents into a file on disk. |
| SaveToMemory <Note> : Windows only. </Note> | Saves the object contents into the global memory. |
Related objects
Linux and Windows
Object Diagram
Output parameter
This object is the output parameter of the CreatePrepareImageMode method of the Engine object.Input parameter
This object is passed as an input parameter to the following methods:- AddImageFile, AddImageFileFromAttachment, AddImageFileWithPassword, AddImageFileWithPasswordCallback, AddImageFileFromMemory methods of the FRDocument object
- CreateFRDocumentFromImage, PrepareBitmapBits, OpenImageFileFromMemory, OpenBitmapBits, OpenBitmap, OpenDib, PrepareBitmap, PrepareDib, InjectTextLayer methods of the Engine object
- Start method of the BatchProcessor object in Linux and Windows
Samples
The object is used in the following code samples:- Linux: CommandLineInterface
- Windows: CommandLineInterface; and demo tools: Engine Predefined Processing Profiles