Properties of the Engine Object
The Engine object exposes a set of properties reflecting global settings of ABBYY FineReader Engine. With the help of these properties you can set the parameters of ABBYY FineReader Engine such as user interface language, parent window of the client application, application title, etc.
- In certain cases, such as training and editing of a user pattern, or editing of a user dictionary, ABBYY FineReader Engine may display dialogs and message boxes. Messages and other text in these dialogs, as well as error description strings (IErrorInfo object), recognition tips, etc., will be written in the specified user interface language. See the description of the MessagesLanguage property.
- The parent window is the window that serves as parent for dialogs and message boxes. Assign the handle of the main application window to this property. ABBYY FineReader Engine uses the standard MFC procedure to find the most suitable parent window for popup windows. Keep it in mind to initialize the parent window handle with correct value or ABBYY FineReader Engine may not perform correctly. See the description of the ParentWindow property.
- The application title is the name of the application that uses ABBYY FineReader Engine. This title serves as the caption of message boxes. See the description of the ApplicationTitle property.
| Name | Type | Description |
|---|---|---|
| Common attributes | ||
| MessagesLanguage | MessagesLanguageEnum |
Defines the language of interaction between ABBYY FineReader Engine and the user. All message boxes, error messages, tips and warnings will be displayed in this language. This parameter stays on between sessions. In order that the interface language changes are fully applied, you need to specify the required value for this property and reload the Engine object. The interface language settings are stored in the InterfaceLanguage.dat file that can be found in the FineReader Engine data folder. If your application must have language settings different from other applications that are using FineReader Engine, you need to use another folder for user-specific data, passing the path to this folder in the call of InitializeEngine function (or method of the IEngineLoader interface).
|
| ParentWindow | __int64 | Stores HWND handle of the main window of an application which uses ABBYY FineReader Engine. This parameter is used to correctly process dialogs and message boxes. You may change this parameter at any time or not set it at all. ABBYY FineReader Engine uses the standard MFC procedure for finding the main window. If the main window owns any popup windows, the last active popup will be used as the parent window rather than the window specified by this property. If you do not set a value for this property, the procedure of finding the main window may fail, and then ABBYY FineReader Engine will perform incorrectly. |
| ApplicationTitle | BSTR | Assign the name of your application to this parameter. It will be used as the title for message boxes. |
| Version | BSTR, read-only | Returns the current version (build number) of ABBYY FineReader Engine. |
| Additional attributes | ||
| PredefinedLanguages | PredefinedLanguages, read-only | Provides access to the collection of predefined languages of ABBYY FineReader Engine. See the list of all predefined languages. |
| CurrentLicense | License, read-only | Returns the current license. |
| AvailablePredefinedLanguages | PredefinedLanguages, read-only | Returns the collection of all predefined languages that are available under the current license. |
| Path | BSTR, read-only | Returns the path to the folder that contains the ABBYY FineReader Engine executables. |
| TotalObjectsCount | int, read-only | Returns the number of unreleased objects. When an object is created, this counter is incremented, and when the object is destroyed, the counter is decremented. You can use this property to trace possible memory leaks. Check the value of this property at the beginning and end of code fragment in which you suspect a memory leak. If the difference is not what you expected, you can narrow the search further and pinpoint the mistake. |
| Processing settings | ||
| AutoCleanRecognizerSession | VARIANT_BOOL |
Specifies whether recognition session should be cleaned after recognition of each page. When processing documents, FineReader Engine tunes itself for recognition of the current type of document (concerning its brightness, text types, fonts, etc.). This information is used during one recognition session and helps to improve recognition quality. In most cases, it is useful to clean the recognition session after recognition of each page; this behavior is used by default. By default, the value of this property is TRUE. |
| MultiProcessingParams | MultiProcessingParams, read-only | Provides access to the parameters of multiprocessing and multiple CPU cores usage. |
| RecognitionSpeedLimit | int | Specifies recognition speed limitation in characters per second. It allows you to specify maximum recognition speed. It may be set to 0, which means that there is no limit on recognition speed. Recognition speed can be limited in the license. In this case, the minimum value is used. |
Samples
The properties are used in all code samples and demo tools.
See also
17.09.2024 15:14:41