ABBYY FineReader Engine 12 and 9.0/9.5 Compatibility

ABBYY FineReader Engine 12 is not binary compatible with ABBYY FineReader Engine 9.0/9.5. Applications that were compiled using ABBYY FineReader Engine 9.0/9.5 should be recompiled using ABBYY FineReader Engine 12 headers and library. Some changes of the source code may be necessary because of the ABBYY FineReader Engine API improvements. The full list of changes:

long data type has been replaced with int data type in all properties and methods that used it.
The GetEngineObject function was removed from ABBYY FineReader Engine. The Engine object must now be loaded by the InitializeEngine function.
The SaveToMemory method provided by many objects returns the handle to the memory buffer as the Handle object.

The LoadFromMemory method provided by many objects receives the pointer to the memory buffer as __int64.

Engine object

Property/Method	What has happened?	Comment
MaxMemoryImageByteSize	Removed	This property is obsolete. The image documents are always created in memory. You can use the SaveTo or SaveToFile methods whenever you need to save the image document on disk.
MessagesLanguage	Possible values changed	The ML_Portuguese and ML_Latvian constants have been removed from the MessagesLanguageEnum enumeration. These message languages are no longer supported.
MultiProcessingMode RecognitionProcessesCount	Removed	Use the corresponding properties of the MultiProcessingParams subobject of the Engine object.
CreateBarcodeAnalysisParams CreateBlocksCollection CreateParagraphTabInfo CreateStraightenLinesParams CreatePdfExtendedParams CreateImageDocumentsCollection CreateLayoutsCollection CreateDocumentAnalyzer CreateDocumentInfo CreateExporter	Removed	Corresponding objects have been removed.
CreateBlock	Removed	Use the AddNew method of the LayoutBlocks object to create a new block and add it to the layout.
CreateLayout	Removed	The Layout object can no longer be used apart from the page it corresponds to.
CreateMultipageImageWriter	Behavior changed	This method now accepts extended image saving parameters for JPEG and TIFF formats.
CreateText	Removed	Currently the Text object cannot be created independently.
CreateLicense	Removed	You can receive the collection of available (activated) licenses using the IEngine::GetAvailableLicenses method.
CreateDocumentInformationDictionaryItem	Removed	Use the AddNew method of the DocumentInformationDictionary collection.
AnalyzeAndRecognizeBlocks AnalyzeRegion AnalyzeTable ExtractBarcodes FindPageSplitPosition RecognizeBlocks ExportPage	Removed	Use the corresponding methods of the FRPage object instead.
CleanDocumentAnalyzer	Removed	This method is obsolete. To clean all internal settings used by FineReader Engine during analysis and recognition, use the CleanRecognizerSession method. To clean up the document, simply release all the references to the FRDocument object.
StraightenLines	Removed	Use the IImageDocument::RemoveGeometricalDistortions method instead.
PerformEnhancement EnhanceImageBlocks	Removed	These methods are no longer provided. You can use methods of the ImageDocument to preprocess images, improving recognition quality and enhancing the image appearance.
ParentWindow	Type changed	The property has the __int64 type.
Licenses	Removed	Use the IEngine::GetAvailableLicenses method instead.
SetCurrentLicense	Input parameters type changed	Serial number is no longer used as an input parameter. The method takes as an input parameter a Boolean value that specifies whether CPU cores should be used in shared mode.
OpenExistingDictionary CreateNewDictionary CreateTextLanguage	Removed	Use corresponding methods of the LanguageDatabase object.
CreateBaseLanguage	Removed	Use the AddNew method of the BaseLanguages object instead.
CreateStandardDictionaryDesc CreateUserDictionaryDesc CreateRegExpDictionaryDesc CreateExternalDictionaryDesc	Removed	Use the AddNew method of the DictionaryDescriptions object to create a dictionary description and the GetAsStandardDictionaryDescription, GetAsUserDictionaryDescription, GetAsRegExpDictionaryDescription, or GetAsExternalDictionaryDescription methods of the DictionaryDescription object to obtain a reference to the object of the corresponding type.
PrepareMemoryImage	Renamed, behavior changed	The new name of the method is PrepareBitmapBits. It takes as an input parameter the path to the folder where the image in the internal format should be saved. The pointer to a memory buffer containing image data is passed as __int64.
PrepareImage PrepareAndOpenImage OpenImage	Removed	Use the IFRDocument::AddImageFile method to open an image file and add it to the document for processing. The ImageDocument object will be accessible via the corresponding FRPage and can be saved on disk later.
PrepareAndOpenMemoryImage PrepareAndOpenBitmap PrepareAndOpenDib	Renamed	The new names of the methods are OpenBitmapBits, OpenBitmap, OpenDib, respectively. The pointer to a memory buffer containing image data is passed as __int64.
OpenMemoryImage OpenBitmapImage OpenDib	Removed	Use the OpenBitmapBits, OpenBitmap, OpenDib methods instead. The differences are: these methods can optionally perform image preparation during conversion to the internal format; these methods take as input parameters horizontal and vertical resolution of the image; the resulting image document is not read-only; modification methods can be applied to it.
LoadImageDocFromMemory	Input parameter type changed	The pointer to a memory buffer containing image data is passed as __int64.
PrepareDib PrepareBitmap	Input parameter type changed	The pointer to a memory buffer containing image data is passed as __int64. These methods take as an input parameter the path to the folder where the image in the internal format should be saved.
AnalyzePage RecognizePage AnalyzePages RecognizePages RecognizeImageAsPlainText RecognizeImageDocumentAsPlainText AnalyzeAndRecognizePage AnalyzeAndRecognizePages SynthesizePages SynthesizePagesEx ExportPages	Removed	Use the methods of the FRDocument and FRPage objects instead.
RecognizeImageFile	Input parameters changed	The method receives a DocumentProcessingParams object instead of PageProcessingParams, and the parameters of image conversion as a PrepareImageMode object.
CreatePDFAExportParams	Removed	This method is obsolete. To create parameters of export to the PDF/A format, use the IEngine::CreatePDFExportParams method.
CreateScanManager	Input parameters number changed	The method receives an optional boolean parameter specifying whether the log of scanning operation should be written.

Engine for Java

Method	What has happened?	Comment
Load LoadEx	Removed	Deprecated method, use Engine.InitializeEngine instead.

Image-related objects

Image document internal format has been changed. It is now represented by a folder with files.
Memory image format interpretation has been changed. It now conforms to HBITMAP.

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
Image	ImageDocument	Removed	The property is no longer supported. You can obtain the Image object only via the parent ImageDocument object, if necessary you can store the reference to the parent object by yourself.
	WriteToFile	The method does not support saving to PDF.	Use one of the export methods to save an image to PDF (e.g., the IFRDocument::Export method).
	GetPicture	Renamed	The new name of the method is GetBitmap. The parameters of the method have been changed: This method does not receive as an input parameter the flags for the image color conversion. To obtain a gray bitmap of an image, you can work with the gray image plane of ImageDocument (IImageDocument::GrayImage) and call GetBitmap method for it. The handle to the output bitmap is returned as the Handle object. The format of the output bitmap has been changed. It now conforms to HBITMAP standard and is the same as input bitmap data for other FineReader Engine methods.
	EstimateBitmapSize	Input parameters number changed	This method does not receive as an input parameter the flags for the image color conversion.
ImageDocument	SaveImage	Removed	Use the SaveTo method instead.
	SaveImageDocToMemory	Renamed, output parameter type changed	The new name of this method is SaveToMemory. The handle to the memory buffer is returned as the Handle object.
	SaveModified	Behavior changed	This method does not overwrite the source image file. It saves the current image document state on disk.
	WriteRectImage	Renamed	The new name of the method is SaveImageRegionTo. The method saves the parts of an image in the internal format to a folder on disk.
	IsSkewCorrect	Renamed	The new name of the property is IsSkewCorrected.
	IsReadOnly	Removed	This property is obsolete. All modification methods work correctly with all image documents.
	IsInternalFormat	Removed	This property is obsolete. Any image document represents an image in internal format.
	ConvertCoordinates	Removed	Use the ConvertCoordinates method of the CoordinatesConverter object.
GP_ prefixed flags		Removed	The flags are no longer in use.
ImageDocumentsCollection		Removed	The object is no longer in use. The methods that used this object have been changed or removed.
ImageTypeEnum	IT_Deskewed	Renamed	The new name of the constant is IT_Modified. The constant is used to denote any modified image, not only a deskewed image.
MemoryImageFormatEnum		Removed	Use BitmapBitsFormatEnum instead. The memory image format has been changed.
PrepareImageMode	CorrectSkew	Removed	Use the CorrectSkew property of the PagePreprocessingParams object instead.
	ImageCompression	Renamed, type changed	This property is now called CompressImage and is of the ThreeStatePropertyValueEnum type. ZIP compression is used.
	RemoveGarbage SmoothColorImage	Removed	Similar functionality is provided via the corresponding methods of the ImageDocument object.
	ColorJpegQuality GrayJpegQuality	Removed	These properties are obsolete. JPEG compression is no longer used for images in internal format.
	CalcSkewByBlackSquares CorrectSkewByBlackSquaresHorizontally CorrectSkewByBlackSquaresVertically CorrectSkewByHorizontalLines CorrectSkewByHorizontalText CorrectSkewByVerticalLines CorrectSkewByVerticalText	Removed	These properties are obsolete. Use the CorrectSkewMode property instead.
ImageCompressionEnum		Removed	The property which used this enumeration now has another type.
ImageModification			This object’s methods work with regions instead of rectangles. All the methods were renamed.
JpegExtendedParams	UseJpeg6Compression	Removed	This property is obsolete. It was ignored in version 9.
EnhancedImage ImageEnhancerValues		Removed	These objects are no longer provided. You can use methods of the ImageDocument to preprocess images, improving recognition quality and enhancing the image appearance.
StraightenLinesParams		Removed	This object is no longer in use. Use the RemoveGeometricalDistortions method of the ImageDocument object, or the CorrectGeometry property of the PagePreprocessingParams object instead.

Layout-related objects

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
Layout	BlackSeparators	Type changed	The black separators are now considered as blocks, and the type of this property is LayoutBlocks.
	LoadBlocks	Removed	This functionality is no longer supported. Blocks of previous versions of FineReader or FineReader Engine cannot be loaded.
	TextAsString	Behavior changed	Text of barcode blocks is not included in the output text line. You can obtain the text of a barcode block via the IBarcodeBlock::Text property.
	Resolution	Removed	To view the resolution of the image, you can use the XResolution and YResolution properties of the corresponding Image object.
Block	BarcodeBlockProperties CheckmarkBlockProperties CheckmarkGroupProperties PictureBlockProperties TableBlockProperties TextBlockProperties	Removed	In this version all the block type interfaces are derived from the IBlock interface and inherit all its properties. You can use the methods of the Block object to access the extended block attributes: GetAsBarcodeBlock, GetAsCheckmarkBlock, GetAsCheckmarkGroup, GetAsRasterPictureBlock, GetAsTableBlock, GetAsTextBlock.
Block	RecognitionStatus	Removed	This functionality is no longer supported. Recognition status of a block is not available. To trace the stage of document or page processing, you can use the OnPageProcessed method of the IFRDocumentEvents or IFRPageEvents interfaces.
BlocksCollection		Removed	The independent collection of blocks no longer exists in the FineReader Engine API. The LayoutBlocks object is a collection of blocks which can only be a subobject of the layout.
TableCells	FindCellIndex	Renamed	The new name of the method is IndexOf.
TableCell	Text ImageProcessingParams RecognizerParams ContainsPicture Name	Removed	Use the corresponding methods and property of the Block object corresponding to the table cell.
TableSeparator	Position Type	Attributes changed	These properties are no longer read-only. You can set the values of these properties.
TableSeparators	Add	Removed	Use the AddNew method instead.
TableSeparatorTypeEnum		Constants changed	Use TST_Invisible instead of TST_White, and TST_Explicit instead of TST_Black.
LayoutsCollection		Removed	The object is no longer in use. The methods that used this object have been changed or removed. See details for the methods that used this object.
AutoAnalysisBlockProperties		Removed	The autoanalysis blocks now can only be used in Visual Components and cannot be created or modified via the FineReader Engine API. To analyze an image zone, you can use the AnalyzeRegion method of the FRPage object.
BarcodeBlockProperties		Removed	The same functionality is provided via the BarcodeBlock object with the following exceptions: BarcodeOrientation — the barcode orientation is defined using the RotationType property of the ImageProcessingParams subobject. Text — the property returns a string instead of the Text object. The text is also accessible via the BarcodeText property. BarcodeSupplementType — the property has been renamed. The new name of the property is SupplementType.
CheckmarkBlockProperties		Removed	The same functionality is provided via the CheckmarkBlock object with the following exceptions: Left, Top, Right, Bottom, SetRect — the properties and the method have been removed. Use the IBlock::Region property of the corresponding block instead.
CheckmarkGroupProperties		Removed	The same functionality is provided via the CheckmarkGroup object with the following exceptions: MaximumCheckedInGroup — the default value of this property has been changed. Add, Insert — the methods have been removed. Use the AddNew method instead.
PictureBlockProperties		Removed	The same functionality is provided via the RasterPictureBlock and VectorPictureBlock objects with the following exceptions: DescriptionText — use the IBlock::Description property instead. ImageEnhancerValues — only the ColorType property is provided via the RasterPictureBlock object. IsEmbeddedInText — not supported.
TableBlockProperties		Removed	Use the TableBlock object instead.
TextBlockProperties		Removed	The same functionality is provided via the TextBlock object with the following exceptions: Text — the property is read-only.
BlockTypeEnum	BT_Picture	Removed	Two types of picture blocks are supported in this version: BT_RasterPicture and BT_VectorPicture.
BlockTypeEnum	BT_AutoAnalysis	Behavior changed	The autoanalysis blocks now can only be used in Visual Components and cannot be created or modified via the FineReader Engine API. To analyze an image zone, you can use the AnalyzeRegion method of the FRPage object.
BlackSeparator		Removed	The same functionality is provided via the SeparatorBlock object with the following exceptions: Direction, Left, Top, Right, Bottom — the properties are no longer supported as separators can be slanting. The coordinates of the start and end points of the separator are provided instead (see the EndPointX, EndPointY, StartPointX, StartPointY properties). Type — use the SeparatorType property instead.
BlackSeparators		Removed	The same functionality is provided via the SeparatorGroup object.
BlackSeparatorDirectionEnum		Removed	These constants are no longer in use. The IBlackSeparator::Direction property has been removed.
BlackSeparatorTypeEnum		Removed	These constants have been replaced by the SeparatorTypeEnum constants.

Language-related objects

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
LanguageDatabase	CreateTextLanguage	Removed	Use the CreateCompoundTextLanguage method instead. Note that the LanguageDatabase object provides a CreateTextLanguage method, but this method has different semantics as compared to the removed method.
LanguageDatabase	CreateCompoundTextLanguage	Input parameter type changed	The method takes as the input parameter the string which contains the comma-separated list of languages to create new language from. This method provides all the functionality previously offered by CreateTextLanguage method.
BaseLanguages	Add	Removed	Use the AddNew method instead.
BaseLanguages	Remove RemoveAll	Renamed	The new names of the methods are DeleteAt, DeleteAll.
PredefinedLanguages	FindLanguage	Renamed	The new name of the method is Find. The method returns null if there is no predefined language with the specified name.
LanguageIdEnum		Constants values changed	The values of the following constants have been changed: LI_Irish, LI_Hawaiian, LI_Latin, LI_Welsh, LI_Frisian, LI_Galician, LI_Guarani, LI_Papiamento, LI_Quechua, LI_Somali, LI_Tajik, LI_Turkmen, LI_Wolof, LI_Yakut, LI_Hausa. When the previous version of FineReader Engine was released, the standard identifiers for these languages did not exist.
DictionaryDescriptions	Add	Removed	Use the AddNew method instead. This method creates a new DictionaryDescription object and adds it into the collection.
DictionaryDescriptions	Remove RemoveAll	Renamed	The new names of the methods are DeleteAt, DeleteAll.
FuzzyStringsCollection		Renamed	The new name of the object is FuzzyStrings. The CopyFrom, Insert, Remove, RemoveAll methods of the object are no longer supported. The collection is read-only.
EnumDictionaryWords	Dictionary	Removed	The property is no longer supported. The reference to the parent Dictionary object cannot be obtained.
EnumDictionaryWords	Next	Behavior changed	The confidence of the word is an output parameter and is no longer an input parameter.
StandardDictionaryDescription	CanUseTrigramms	Renamed	The new name of the property is CanUseTrigrams.

Text-related objects

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
Paragraphs	Find	Renamed	The new name of the method is IndexOf.
Text	BackgroundColor	Removed	The background color is an attribute of a paragraph or a block. Use the corresponding properties of the ParagraphParams and Block objects.
	IsMirrored	Removed	This property is no longer supported.
	Append	Removed	You can use the InsertText method of the Paragraph object instead.
	IsPlain CopyFrom	Removed	The functionality is no longer supported. In this version text is usually associated to some place in the document and cannot be simply copied from one object to another without specifying its location. Therefore to copy some text from one location to another, you can use the IText::AppendEmptyParagraph and IParagraph::InsertText methods.
	DiscardExtendedRecAttributes	Removed	The ExtendedRecAttributes object is no longer in use. If you do not need to use additional attributes of characters and words, keep the SaveCharacterRecognitionVariants, SaveWordRecognitionVariants properties of the RecognizerParams object set to FALSE during recognition.
	DiscardRectangles	Removed	Use the properties and methods of the CharParams object to edit characters regions.
	TextOrientation	Type changed	This property provides access to the TextOrientation object.
	Insert InsertParagraphBreak	Removed	Use the InsertText and InsertParagraphBreak methods of the Paragraph object, respectively.
	SeparateHorz SeparateVert	Removed	The functionality is no longer supported. Text cannot be divided into parts by a horizontal or vertical line as this can damage the logical structure of a document.
	TextRole	Removed	This property has been removed due to the removal of document logical structure API, as it is no longer possible to access the parts of document by their role in the logical structure.
TextOrientationEnum		Removed	These constants are no longer in use. The TextOrientation object provides access to text orientation.
Paragraph	Bookmark	Input parameter changed	The property takes as an input parameter the index of the bookmark in the internal collection of the paragraph’s bookmarks instead of its position inside the paragraph.
	GetBookmarkRange	Input parameter changed	The method takes as an input parameter the name of the bookmark instead of its position inside the paragraph.
	Params	Renamed	The new name of the property is ExtendedParams.
	TabLeaderInfo	Removed	Use the TabPositions property instead.
	ParentText	Removed	This property is no longer supported. Paragraph can either be an element of recognized text, or an element of logical structure of a document. Therefore this property cannot be unambiguously defined.
	Id	Removed	The paragraph identifier is no longer available because the document logical structure cannot be accessed via the API.
	SetCharParams	Input parameters number changed	The method takes an OR combination of the StyleParamsEnum constants as one of the input parameters.
	Left Top Right Bottom	Behavior changed	The coordinates of the paragraph borders are not available for the paragraphs of barcodes. You can obtain the coordinates of separate symbols in a recognized barcode using the Left, Top, Right, Bottom properties of the BarcodeSymbol object.
	SetRect	Removed	This functionality is no longer supported. The coordinates of a paragraph are read-only and are provided for reference. The coordinates can be only defined for blocks (IBlock::Region property).
	ImageEnhancerValues	Removed	Image enhancement is no longer supported.
ParagraphParams	ChangeParagraphTabInfo GetParagraphTabInfoCopy	Removed	Use the TabPositions, TabPosition objects and the IParagraph::TabPositions property instead.
	HasUncertainAlignment	Removed	The property is obsolete. The alignment cannot be detected uncertainly.
	Width	Removed	The property is obsolete. The width can be only calculated for blocks (IBlock::Region property).
	UserProperty	Removed	This functionality is no longer supported. This property cannot be retained during text editing. If you want to associate some user information with a paragraph, you can use bookmarks in the paragraph (IParagraph::Bookmark property).
ParagraphLine	BaseLine	Attribute changed	The property becomes read-only.
	Left Top Right Bottom	Behavior changed	The coordinates of the line borders are not available for the paragraphs of barcodes. You can obtain the coordinates of separate symbols in a recognized barcode using the Left, Top, Right, Bottom properties of the BarcodeSymbol object.
	SetRect	Removed	This functionality is no longer supported. The coordinates of a paragraph line are read-only and are provided for reference. The coordinates can be only defined for blocks (IBlock::Region property).
ParagraphTabInfo		Removed	The same functionality is provided via the TabPosition object.
CharParams	IsHidden	Removed	The property is obsolete. Recognized characters cannot have this attribute. If you want to assign some user- specific information to a character, you can use bookmarks in the paragraph (IParagraph::Bookmark property).
	IsStartStopSymbol	Removed	Use the IsStartStopSymbol property of the BarcodeSymbol object instead.
	ExtendedRecAttributes	Removed	This object is no longer in use. Similar properties are available via the CharacterRecоgnitionVariant and WordRecognitionVariant object.
	CharacterHeight HasUncertainHeight	Removed	These properties are no longer supported. You can obtain detailed information on character configuration via the ICharParams::CharacterRegion property.
ExtendedRecAttributes		Removed	Use the CharacterRecognitionVariant, WordRecognitionVariant, and CharParams objects instead: CharConfidence, SerifProbability — use the corresponding properties of the CharacterRecоgnitionVariant object. IsWordFromDictionary, MeanStrokeWidth — use the corresponding properties of the WordRecognitionVariant object. IsWordIdentifier, IsWordNormal, IsWordNumeric — use the ModelType property of the WordRecognitionVariant object: IsWordNormal set to TRUE is equal to the ModelType property set to WMT_MonoLingualWord \| WMT_RegExpWord IsWordNumeric set to TRUE — to WMT_Number \| WMT_NumberWithQualifier \| WMT_RomanNumber \| WMT_PhoneNumber \| WMT_UrlOrEmail IsWordIdentifier set to TRUE — to WMT_BilingualComposit \| WMT_Acronym \| NumberWithQualifier \| WMT_WordNumberComposite \| WMT_BilingualWordNumberComposite \| WMT_RomanNumber \| WMT_MixedFormDictionaryWord \| WMT_PhoneNumber \| WMT_Punctuation \| WMT_FileName \| WMT_UrlOrEmail WordPenalty — use the WordConfidence property of the WordRecognitionVariant object. IsWordStart — use the IsWordFirst or IsWordLeftmost properties of the CharParams object.
CFL_ prefixed flags		Renamed	The new name of the module is CharacterFlags.
	CFL_Bold CFL_Italic CFL_Underlined CFL_Strikeout CFL_SmallCaps CFL_FontSize CFL_FontName CFL_Scale CFL_Spacing CFL_Color CFL_BaseLine	Removed	Use the corresponding constants of the StyleParamsEnum enumeration.
	CFL_Hidden CFL_UncertainCharHeight CFL_CharacterHeight CFL_ExtRecAttributes CFL_Rectangle CFL_IsStartStopSymbol	Removed	These constants are no longer in use. Corresponding properties of the CharParams object are no longer supported.
PlainText	SaveToTextFile	Input parameters number changed	The following input parameters have been added: encoding type and code page of the output file. The bUnicode input parameter has been removed; this setting is covered by the encoding type parameter.

Document-related objects

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
FRDocument	AddImage	Renamed	The new name of the method is AddImageDocument.
	Analyze AnalyzePages	Input parameters number changed	These methods take as input parameters a set of subobjects of the PageProcessingParams object — only those parameters that are needed for page analysis are passed to these methods.
	Recognize RecognizePages	Input parameters number changed	These methods now additionally receive the ObjectsExtractionParams object as an input parameter.
	AnalyzeAndRecognize AnalyzeAndRecognizePages	Removed	The same functionality is provided via the Process and ProcessPages methods of the FRDocument object with the PerformSynthesis property of the DocumentProcessingParams input parameter set to FALSE.
	AutoFlush	Removed	Use the PageFlushingPolicy property instead.
	Process	Input parameters number changed	The method receives all necessary parameters in one DocumentProcessingParams object.
IFRDocumentEvents	OnRecognizerTip	Renamed, behavior changed	The new name of the method is OnWarning. It now has an additional parameter which specifies the index of the page in the document to which the warning refers.
FRPage	AnalyzeAndRecognizeBlocks AnalyzeBlock	Removed	These methods were generally used to perform layout analysis inside blocks of the autoanalysis type. As this type of block is no longer supported the methods have been removed. You can use the AnalyzeRegion method to perform layout analysis in an image zone, and then call the RecognizeBlocks method.
	Analyze AnalyzeTable	Input parameters number changed	The methods take as input parameters a set of subobjects of the PageProcessingParams object — only those parameters that are needed for page analysis are passed to these methods. The Analyze method does not perform correction of page orientation, inversion, and geometrical distortions any more. To preprocess the image, use corresponding methods of the FRPage object, or perform all these operations as a whole using the IFRPage::Preprocess method.
	AnalyzeAndRecognize	Renamed	The new name of the method is PreprocessAnalyzeRecognize. The only difference from the old method is that now this method receives only one input parameter of the PageProcessingParams type, which contains all the necessary settings for processing.
	Recognize RecognizeBlocks	Input parameters number changed	These methods now additionally receive the ObjectsExtractionParams object as an input parameter.
	Flush	Input parameters number changed	This method receives a boolean input parameter specifying whether the data should be saved to disk. This is useful in case the data is unchanged.
IFRPageEvents	OnRecognizerTip	Renamed	The new name of the method is OnWarning.
FRPages	Find Remove	Renamed	The new names of the methods are IndexOf, DeleteAt.
DocumentInformationDictionary	Add Insert	Renamed	Use the AddNew method instead.
DocumentInformationDictionary	CopyFrom	Removed	This method is no longer supported. To copy the values of elements from another collection, you can add new elements to the collection using the AddNew method and specify the same values of elements.
DocumentContentInfo	DocumentInformationDictionary	Behavior changed	The property does not return a copy of the object any more, it returns a constant object.
DocumentInfo		Removed	The methods which required an object of this type have been removed.
PageSplitDirectionEnum	PSD_NoneSplit	Renamed	The new name of the constant is PSD_NoSplit.

Mechanism objects

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
DocumentAnalyzer		Removed	The object is obsolete. Its methods were replaced by more efficient methods of the FRDocument and FRPage objects, which do not require you to maintain the DocumentInfo object on all processing stages.
	AnalyzeAndRecognizeBlocks	Removed	Use the IFRPage::Analyze and IFRPage::RecognizeBlocks methods.
	AnalyzeAndRecognizePage	Removed	Use the IFRPage::PreprocessAnalyzeRecognize method instead.
	AnalyzeAndRecognizePages	Removed	Use the IFRDocument::Process method instead. It performs full processing of the document, including document synthesis.
	AnalyzePage	Removed	Use the IFRPage::Analyze method instead.
	AnalyzePages	Removed	Use the IFRDocument::Analyze method instead.
	AnalyzeRegion	Removed	Use the IFRPage::AnalyzeRegion method instead.
	AnalyzeTable	Removed	Use the IFRPage::AnalyzeTable method instead.
	ExtractBarcodes	Removed	Use the IFRPage::ExtractBarcodes method instead.
	RecognizeBlocks	Removed	Use the IFRPage::RecognizeBlocks method instead.
	RecognizeImageDocumentAsPlainText	Removed	To recognize the page as plain text, use the IFRPage::PreprocessAnalyzeRecognize method, then access the IFRPage::PlainText property.
	RecognizePage	Removed	Use the IFRPage::Recognize method instead.
	RecognizePages	Removed	Use the IFRDocument::Recognize method instead.
	StraightenLines	Removed	Use the IImageDocument::RemoveGeometricalDistortions method instead.
	PerformEnhancement EnhanceImageBlocks	Removed	Image enhancement through the old API is not supported. You can use methods of the ImageDocument to preprocess images, improving recognition quality and enhancing the image appearance.
IDocumentAnalyzerEvents		Removed	This interface is no longer necessary because the object which reported events has been removed. The IFRDocumentEvents and IFRPageEvents interfaces provide similar information on progress and errors for the objects which replaced DocumentAnalyzer.
FREngineModuleEnum	FREM_DocumentAnalyzer	Removed	This constant is no longer in use.
Exporter		Removed	The object is obsolete. Its methods were replaced by more efficient methods of the FRDocument object.
Exporter	ExportPages ExportPagesEx	Removed	Use the IFRDocument::Export method instead.
IExporterEvents		Removed	This interface is no longer necessary because the object which reported events has been removed. The IFRDocumentEvents interface provides similar information on progress and errors for export operations.
ScanManager	ScanSources	Type changed	This property returns the ScanSources collection of scanning sources. New ScanSource interface provides access to extended scanning options.
	ScanOptionsInterfaceType	Removed	To set the type of scanning options dialog box use the UserInterfaceType parameter of the Scan and BeginScan methods of the ScanSource object.
	ScanSourceSettings	Removed	The settings are specified for each scanning source separately. Use the ScanSource::ScanSettings property to specify scanning source settings.
	Scan	Removed	Use the Scan method of the ScanSource object for synchronous scanning operation. But note that asynchronous scanning is now also supported, via the BeginScan method of the ScanSource object.
IScanManagerEvents		Removed	This interface is no longer in use. The scanning notifications are received through new IScanCallback interface.
ScanSourceSettings	Brightness Delay	Default value changed	The default value of these properties is 0.
	BrightnessControl PaperSize Resolution RotationAngle	Default value changed	The default values of these properties are determined by the scanner capabilities.
	PaperBottom PaperRight	Default value changed	The default value of these properties is 0. The scanning area will be selected by the scanner.
	PictureMode	Renamed, default value changed	The new name of this property is ColorMode. The default value of this property depends on the scanner.
	UseFeeder	Removed	Use the PaperFeedMode property instead.
	StopBetweenPages PauseBetweenPages	Removed	Use the PauseBetweenPagesMode property instead.
ScanPictureModeEnum		Renamed	The new name of this enumeration is ScanColorModeEnum. The constants have been renamed likewise to have the SCM_ prefix instead of SPM_.
ScanPageRotationAngleEnum		Renamed	The new name of this enumeration is ScanRotationAngleEnum. The word Page is superfluous.
ScanOptionsInterfaceTypeEnum		Removed	The properties that used this enumeration have been removed. The ScanSourceUITypeEnum provides a similar set of constants.

Parameter objects

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
PageProcessingParams	BarcodeParams TableAnalysisParams	Removed	Use the corresponding properties of the PageAnalysisParams subobject.
PageProcessingParams	PageSynthesisParams	Removed	The PageSynthesisParams object is no longer supported. The same functionality is provided via the SynthesisParamsForPage and SynthesisParamsForDocument objects.
BarcodeParams	IsEAN13InterpretedAsUPCA	Removed	The UPC-A barcode type can be specified explicitly: use the BT_UPCA enumeration constant in the value of the Type property of the BarcodeParams object.
BarcodeParams	PDF417CodePage	Renamed	The new name of the property is CodePage.
PageAnalysisParams	DetectOrientation	Removed	Use the OrientationDetectionParams property of the PagePreprocessingParams object.
	DetectInvertedImage	Removed	Use the CorrectInvertedImage property of the PagePreprocessingParams object.
	DetectInvertedTexture	Removed	Use the RemoveTexture property of the ObjectsExtractionParams object instead.
	DetectMatrixPrinter DetectPorousText FastObjectsExtraction ProhibitColorImage RemoveTexture	Removed	Use the corresponding properties of the ObjectsExtractionParams object instead.
	FlexiFormsDA FullTextIndexDA	Removed	Use the EnableTextExtractionMode property of this object, and EnableAggressiveTextExtraction properties of the ObjectsExtractionParams object or the DetectTextOnPictures property of the PageAnalysisParams object.
	ProhibitClockwiseRotation ProhibitCounterclockwiseRotation ProhibitUpsidedownRotation	Removed	The corresponding properties are no longer in use.
	SingleColumnMode	Removed	This property is no longer supported in FineReader Engine recognition technologies.
RecognizerParams	ErrorHiliteLevel	Removed	Use the new HighlightSuspiciousCharacters property, which dispenses with various levels of confidence and allows you a simple choice: either highlight uncertainly recognized characters or not. If you need a finer distinction, use the CharConfidence property of the selected CharacterRecognitionVariant, although matching recognition confidences for different characters against the same threshold may not always provide consistent results.
	TextLanguage	Attribute changed	The property is described by the propput keyword in the type library. Former description as putref didn’t make a difference because this property is an interface pointer in any case.
	PossibleTextTypes TextType	Removed	The properties are obsolete. Use the TextTypes property instead.
	CJKTextDirection	Removed	Use the ITextOrientation::ReadingType property instead. If you set this property to TRT_Unknown, text direction will be detected automatically. By default, this property is TRT_Unknown as well.
PageSynthesisParams		Removed	The same functionality is provided via the SynthesisParamsForPage and SynthesisParamsForDocument objects.
FieldMarkingTypeEnum	FMT_GreyBoxes	Renamed	The new name of the constant is FMT_GrayBoxes.
TextTypeEnum	TT_ToBeDetected	Removed	The constant is obsolete. To detect text type automatically, specify a set of possible text types in the IRecognizerParams::TextTypes property.
SynthesisParamsForDocument	DetectCaptions DetectColumns DetectFootnotes DetectRunningTitles	Removed	The corresponding properties are available through the DocumentStructureDetectionParams subobject of the SynthesisParamsForDocument object.
	DetectBold DetectDropCaps DetectFontSize DetectItalic DetectSerifs DetectSmallCaps DetectSubscriptsSuperscripts DetectUnderlineStrikeout MonospaceDetectionMode DetectScaleSpacing	Removed	The corresponding properties are available through the FontFormattingDetectionParams subobject of the SynthesisParamsForDocument object.
	DontReplaceBullets	Removed	This property is obsolete and no longer supported. To change parameters of a list level (including bullets and numbering), you can use the ListLevel object.
	UseVisualOrderForBidirectionalText	Removed	This property is obsolete and no longer supported. The order of text is fixed: it is visual after recognition, and logical after document synthesis.
	InsertEmptyParagraphsForBigInterlines	Removed	Use the ITextExportParams::RetainLayout property to emulate the original text layout with the help of spaces.
	AddRecognizedTextFontName GetRecognizedTextFontName CleanRecognizedTextFontNames	Removed	Use the FontSet object instead. This object is configured by default for easiest use in different recognition languages. FineReader Engine can filter all system fonts on the basis of recognition languages specified for the text and add them to the synthesis font set.
	SaveRecognitionInfo	Removed	If you want to save recognition information, use the SaveCharacterRecognitionVariants or SaveWordRecognitionVariants property of the RecognizerParams object.
SynthesisParamsForPage	DoNotExtractSeparators	Removed	This property is no longer supported. You can use the IPageAnalysisParams::DetectSeparators and IDocumentStructureDetectionParams::ClassifySeparators properties instead.
SynthesisParamsForPage	AllowGrayBackgroundColor AllowGrayTextColor CorrectDynamicRange DetectBackgroundColor DetectTextColor	Type changed	These properties now take values of the new ThreeStatePropertyValueEnum, which provides the opportunity not only to turn the setting on and off, but also make the selection automatically (TSPV_Auto constant). All these properties have TSPV_Auto value by default.
ParagraphExtractionModeEnum	PEM_SingleLineParagraphsWithSpaceFormatting	Removed	Use the ITextExportParams::RetainLayout property to emulate the original text appearance with the help of spaces while exporting to TXT format.
ErrorHiliteLevelEnum		Removed	The property which used this enumeration has been removed.
HTMLExportParams	PictureFormat Quality PictureResolution	Removed	Use the ColorPictureFormats, GrayPictureFormats, JpegQuality, Resolution properties of the PictureExportParams subobject instead. This object now contains all parameters for picture export to all formats except PDF.
	CodePageType	Removed	This property is no longer supported. The code page is selected from all types of code pages. This property can be removed from code of your application with no influence on results of export.
	UseUnicode	Removed	This property is no longer supported. Similar functionality is provided via the EncodingType property.
	RunningTitleMode	Removed	Use the WriteRunningTitles boolean property instead. There are only two options for HTML export format: write running titles as plain text or not write them at all.
	Author Keywords Subject Title	Removed	Use the corresponding properties of the DocumentContentInfo object to set the metadata values and the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property) to specify which document metadata must be saved during export.
HTMLFormatModeEnum	HFM_TwoFormats32_40	Removed	This format is obsolete and is no longer supported.
HTMLSynthesisModeEnum	HSM_PageLayout	Removed	Page structure is no longer retained in the output HTML document. Logical structure of the document can be saved using the HSM_FlexibleLayout constant.
PPTExportParams			Export to PPT format is no longer supported. These parameters are used for export to PPTX.
	WrapTextInBlock	Behavior changed	The value of this property is no longer ignored when exporting to PPTX format.
	PictureFormat Quality PictureResolution	Removed	Use the ColorPictureFormats, GrayPictureFormats, JpegQuality, Resolution properties of the PictureExportParams subobject instead. This object now contains all parameters for picture export to all formats except PDF.
	RunningTitleMode	Removed	Use the WriteRunningTitles boolean property instead. There are only two options for PPT export format: write running titles as plain text or not write them at all.
	Author Keywords Subject Title	Removed	Use the corresponding properties of the DocumentContentInfo object to set the metadata values and the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property) to specify which document metadata must be saved during export.
RTFExportParams	PictureFormat Quality PictureResolution	Removed	Use the ColorPictureFormats, GrayPictureFormats, JpegQuality, Resolution properties of the PictureExportParams subobject instead. This object now contains all parameters for picture export to all formats except PDF.
	RunningTitleMode	Removed	Use the WriteRunningTitles boolean property instead. There are only two options for RTF export format: write running titles according to the RTF running title standard or not write them at all.
	ForceFixedPageSize PaperHeight PaperWidth	Removed	Use the PaperSizeParams property instead.
	Author Keywords Subject Title	Removed	Use the corresponding properties of the DocumentContentInfo object to set the metadata values and the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property) to specify which document metadata must be saved during export.
	KeepTextAndBackgroundColor	Removed	Use the KeepTextColor and BackgroundColorMode properties instead. You can now set these two parameters separately.
	KeepPages	Removed	Use the KeepPageBreaks property instead.
	FormatWord95 WriteWordXML WriteCustomXMLTags	Removed	These properties are obsolete because the formats are no longer in use.
	EnhanceImages	Removed	Image enhancement through the old API is not supported. You can use methods of the ImageDocument to preprocess images, improving recognition quality and enhancing the image appearance.
	PageSynthesisMode	Default value changed	By default, the value of this property is PSM_RTFEditableCopy.
RTFPageSynthesisModeEnum	PSM_Unknown	Removed	This constant is obsolete and no longer in use.
RTFPageSynthesisModeEnum	PSM_RTFColumns	Removed	Use the PSM_RTFEditableCopy constant instead.
TextExportParams	TXTIsCSV CSVTablesOnly	Removed	To export to CSV format, use the ExportFormat property.
	CodePageType	Removed	This property is no longer supported. The code page is selected from all types of code pages. This property can be removed from code of your application with no influence on results of export.
	ExportParagraphsAsOneLine	Behavior changed	The value of this property is ignored if the RetainLayout property is TRUE.
	InsertEmptyLineBetweenParagraphs	Behavior changed	The value of this property is ignored if the RetainLayout property is TRUE.
	RunningTitleMode	Removed	Use the WriteRunningTitles boolean property instead. There are only two options for TXT and CSV export formats: write running titles as plain text or not write them at all.
	AppendEOF	Removed	This property is obsolete. Modern operating systems do not pay attention to the End Of File symbol.
XLExportParams	RunningTitleMode	Removed	Use the WriteRunningTitles boolean property instead. There are only two options for XLS/XLSX export format: write running titles as plain text or not write them at all.
XLExportParams	Author Keywords Subject Title	Removed	Use the corresponding properties of the DocumentContentInfo object to set the metadata values and the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property) to specify which document metadata must be saved during export.
FileExportFormatEnum	FEF_PPT	Removed	Export to PPT format is no longer supported. For export to PPTX use the FEF_PPTX constant.
	FEF_PDFA	Removed	The constant is obsolete. Use the PDFExportParams object with the PDFAComplianceMode property set to support the necessary type of PDF/A standard.
	FEF_RTF	Behavior changed	This constant specifies RTF saving format. DOC output format is not supported. If you use this constant in an export method together with DOC extension of the output file, the output file will have DOC extension but will be RTF, in fact.
ExportPictureFormatEnum		Removed	The constants are no longer in use.
RunningTitleModeEnum		Removed	The constants are no longer in use.
RTFPageOrientationEnum		Renamed	The new name of the enumeration is PageOrientationEnum.
XMLExportParams	WriteCharAttributes	Type changed	The property has the XMLCharAttributesEnum type. The old WriteCharAttributes property set to TRUE is equivalent to the new property set to XCA_Basic, set to FALSE — to XCA_None.
	WriteAsciiCharAttributes WriteExtendedCharAttributes	Removed	Use the WriteCharAttributes property set to XCA_Ascii and XCA_Extended, respectively.
	WriteNondeskewedCoordinates	Default value changed	By default, the value of this property is TRUE.
FontModeEnum		Removed	These constants are no longer in use. The properties that used these constants have been replaced with some other properties or removed. See details for corresponding properties.
PDFMRCParams	MRCEnabled	Removed	Use the MRCMode property of the PDFExportParams object instead.
	BackgroundDownSampling	Default value changed	The new default value of this property is 2.
	MonochromeText	Default value changed	The new default value of this property is FALSE.
	PicturesInBackground	Renamed, type changed	This property is now called ProcessPicturesAsBackground and is of ThreeStatePropertyValueEnum type.
	BackgroundFormat BackgroundQuality ColorMaskFormat ColorMaskQuality TextMaskFormat TextMaskQuality	Removed	Use similar properties of the PDFPictureCompressionParams object.
	BackgroundColor	Default value changed	The new default value of the property is -1, which means that the background color should be detected automatically based on the original background.
	CompressionLevel	Removed	This property contained obsolete settings, which cannot be used in this version. You can remove this property from code of your application with no effect on PDF export.
	TextMaskDownSampling	Removed	This functionality is no longer supported. Down sampling rate of text mask cannot be specified in this version.
PDFEncryptionInfo	UseAES	Removed	Use the EncryptionAlgorithm property to select the encryption type.
PDFExportParams PDFAExportParams		Removed	The new PDFExportParams object can be used to setup the export to PDF and PDF/A format. See below the equivalence between the properties of the objects (property of old PDFExportParams (PDFAExportParams) — corresponding property of new PDFExportParams): EmbedFonts — use the PDFFeatures property (IPDFExportFeatures::FontEmbeddingMode) EncryptionInfo — the PDFFeatures property (IPDFExportFeatures::EncryptionInfo) ExportMode — TextExportMode FontMode — Removed. This property is obsolete. Use the FontSet property of the SynthesisParamsForDocument object instead. KeepTextAndBackgroundColor — use the PDFFeatures property (IPDFExportFeatures::TextAndBackgroundColorMode) MRCParams — the PictureCompressionParams property (IPDFPictureCompressionParams::MRCParams) PaperHeight — the PDFFeatures property (IPDFExportFeatures::PaperSizeParams, PaperHeight property) PaperWidth — the PDFFeatures property (IPDFExportFeatures::PaperSizeParams, PaperWidth property) PDFVersion — the PDFFeatures property (IPDFExportFeatures::PDFVersion) PictureFormat — the PictureCompressionParams property (IPDFPictureCompressionParams::BwPictureFormats, or IPDFPictureCompressionParams::ColorPictureFormats, or IPDFPictureCompressionParams::GrayPictureFormats) PictureResolution — Resolution Quality — the PictureCompressionParams property (IPDFPictureCompressionParams::JpegQuality) ReplaceUncertainWordsWithImage — the PDFFeatures property (IPDFExportFeatures::ReplaceUncertainWordsWithImage) RunningTitleMode — the PDFFeatures property (IPDFExportFeatures::WriteRunningTitles) SetPageSizeByLayoutSize — the PDFFeatures property (IPDFExportFeatures::PaperSizeParams, set the PaperSizeMode property to a suitable constant) Author, Creator, Keywords, Producer, Subject, Title - the DocumentContentInfo object (property of FRDocument object); the IPDFExportFeatures::MetaDataWritingParams property lets you set what information about the document is saved into the result file WriteLinks — the PDFFeatures property (IPDFExportFeatures::WriteLinks) WritePDFA1A — PDFAComplianceMode (set the property to PCM_Pdfa_1a to export to PDF/A-1a format) WriteTaggedPDF — the PDFFeatures property (IPDFExportFeatures::WriteTaggedPDF)
PDFMRCCompressionLevelEnum		Removed	The constants are no longer in use. The properties that used these constants have been replaced with some other properties or removed. See details for corresponding properties.
WritingStyleEnum	WS_Default	Removed	Windows Enum We recommend using WS_Auto to ensure the best recognition quality. If you need to select the writing style corresponding to the current operating system language, use WS_DetectByLocale.

License-related objects

You can receive the collection of available (activated) licenses using the IEngine::GetAvailableLicenses method. The IEngine::CreateLicense method is no longer supported.

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
License	IsActivated	Removed	Only activated licenses are available.
	IsAbsoluteTimeLimitationUsed IsRelativeTimeLimitationUsed RelativeDays	Removed	For activated licenses use the ExpirationDate method of the License object.
	CounterMeasureUnit	Removed	A license may have several counters with different measuring units.
	LimitationPeriod RemainingUnits UnitsPerPeriod	Removed	Use the VolumeRefreshingPeriod, VolumeRemaining, Volume properties instead, respectively. These properties take as the input parameter a LicenseCounterTypeEnum constant as the license may have several counters with different measuring units.
AEM_ prefixed flags		Module renamed	The new name of the module is AvailableEngineModulesFlags.
	AEM_FullTextSearchDA AEM_FlexiFormsDA	Removed	The corresponding modules are no longer used.
	AEM_ASCII	Removed	Corresponding license module is no longer in use. The AEM_ProcessAsPlainText constant provides access to the Processing as Plain Text module, which provides similar functionality.
	AEM_1DBarcode AEM_2DBarcodePDF417 AEM_Aztec AEM_QRCode AEM_DataMatrix AEM_BarcodeAutolocation	Removed	The corresponding AvailableBarcodeModulesFlags are used. The AEM_2DBarcodePDF417 constant corresponds to ABM_PDF417 constant.
	AEM_CJK AEM_Thai AEM_Vietnamese AEM_Hebrew AEM_FineReaderXIX AEM_LanguageDatabase	Removed	The corresponding AvailableLanguageSetsFlags are used.
AEF_ prefixed flags		Module renamed	The new name of the module is AvailableExportFormatsFlags.
AEF_ prefixed flags	AEF_DBF	Removed	Export to DBF format is no longer supported because the format is going out of wide use.
ATT_ prefixed flags		Module renamed	The new name of the module is AvailableTextTypesFlags.
AVC_ prefixed flags		Module renamed	The new name of the module is AvailableVisualComponentsFlags.
LicenseLimitationPeriodEnum		Renamed	The new name is VolumeRefreshingPeriodEnum. It provides the same functionality with the following exception: LLP_Hour — removed. This volume refreshing period is no longer supported.
LicenseCounterMeasuringUnitEnum		Renamed	The new name is LicenseCounterTypeEnum.
LicenseCollection		Renamed	The new name of the object is Licenses.

Supplementary objects

Object/Enumeration	Property/Method/Constant	What has happened?	Comment
LongsCollection		Renamed	The new name of the object is IntsCollection. The new object differs from the old one in the following respects: Insert, Remove, RemoveAll methods have been renamed to InsertAt, DeleteAt, DeleteAll, respectively. CopyFrom method is no longer supported. To create a copy of the collection, you can create a new collection using the IEngine::CreateIntsCollection method and add the same elements to it using the Add method.
StringsCollection	Insert Remove RemoveAll	Renamed	The new names of the methods are InsertAt, DeleteAt, DeleteAll.
StringsCollection	Removed	The method is no longer supported. To create a copy of the collection, you can create a new collection using the IEngine::CreateStringsCollection method and add the same elements to it using the Add method.
IRecognizedPages		Removed	The methods which required an object of this type have been removed.

Overview

Export Formats

Backward Compatibility Issues

ABBYY FineReader Engine 12 and 9.0/9.5 Compatibility

See also

Overview

Export Formats

Backward Compatibility Issues

​See also

See also