English (English)

Document-Related Objects Compatibility with Version 10

This section describes all changes to document-related objects which may require changes in the source code of your applications.

  • The API which provided access to the logical structure of the document (DocumentStructure, PageStructure and their subobjects) has been removed. Editing the properties and contents of the document via the deleted objects could have led to unpredictable results on export. If you need to verify or postprocess the recognition results, work with the data via the Layout subobject of each FRPage and call any of the methods which perform document synthesis when done. The logical structure of the document will then be recreated and used at the export stage, although it will no longer be available for editing via FineReader Engine API. The future versions of ABBYY FineReader Engine may provide read-only access to some of the document logical structure.
Object/Enumeration Property/Method/Constant What has happened? Comment
FRDocument AddImage Renamed The new name of the method is AddImageDocument. This method has been renamed to make it clear that it works with ImageDocument, not an image file from disk.
AddImageFileFromMemory Input parameters number changed
  • The pointer to a memory buffer containing image data is passed as __int64. This change has been made for 64-bit operating systems support.
  • The variable fileFormat is no longer used as an input parameter. File format is determined using the fileName parameter.
  • PDF, DjVu and WDP files can be opened from memory. Because of this the method now receives the pointer to IImagePasswordCallback interface, which is necessary for opening password-protected PDF files.
  • The method also receives an IntsCollection object specifying which pages of a multi-page file should be added.

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.

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.
Process Input parameters number changed The method receives all necessary parameters in one DocumentProcessingParams object.
IFRDocumentEvents OnRecognizerTip Renamed

The new name of the method is OnWarning. It can deliver warnings as well as recognizer tips to the client, and also process Windows messages to avoid the effect that the application "is not responding".

It also has an additional parameter which specifies the index of the page in the document to which the warning refers.

Artefact

BackgroundLayer

Caption

Captions

DocumentElement

DocumentSection

DocumentStream

DocumentStructure

Footnote

Footnotes

FootnoteSeries

FootnoteSeriesArray

GlobalStyleStorage

Incut

IncutGroup

IncutGroups

MainText

PageBlackSeparator

PageElement

PageElements

PageSection

PageSections

PageStream

PageStructure

RunningTitle

RunningTitleSeries

RunningTitleSeriesArray

RunningTitleSeriesText

StreamElementLocationParams

TextBarcode

TextPicture

TextTable

TextTableCell

 Removed These objects represented the logical structure of the document and its various parts. Editing the document structure is no longer supported, as its incorrect use could affect the appearance of the exported document, and any text verification or other modifications may be performed via the document API (FRDocument, FRPage and subobjects). The future versions of ABBYY FineReader Engine may provide read-only access to some of the document logical structure.

BorderFlags

CaptionPositionEnum

DocumentElementTypeEnum

FootnoteNumberingTypeEnum

FrameHorizontalReferenceEnum

FrameVerticalReferenceEnum

PageBlackSeparatorRoleEnum

PageBlackSeparatorTypeEnum

PageElementTypeEnum

StreamElementAlignmentEnum

StreamTypeEnum

TableCellVertAlignmentEnum

TextTableSeparatorTypeEnum

TextWrappingEnum

 Removed These enumerations were used by the document structure objects that are no longer available.
FRPage

Analyze

AnalyzeRegion

AnalyzeTable

 Behavior 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. Image preprocessing is a separate processing stage now. To correct orientation, inversion, geometrical distortion, 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.
CorrectResolution Removed

Use the IFRPage::DetectResolution and IImageDocument::ChangeResolution methods instead. This allows the user to check the resolution suggested by the DetectResolution method before applying it to the image. It may be that the proposed correction is so small that it is no use applying it.

However, note that you can still correct the resolution automatically during preprocessing by setting the CorrectResolution property in PagePreprocessingParams.
RemoveGeometricalDistortions Renamed The new name of the method is CorrectGeometricalDistortions. The Correct... prefix is more natural in this context and is already used in other methods and properties dealing with image preprocessing.
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, because the method will work much quicker when saving is not required.
FlushExt Removed The Flush method has the same signature as the FlushExt method.
IFRPageEvents OnRecognizerTip Renamed The new name of the method is OnWarning. It can deliver warnings as well as recognizer tips to the client, and also process Windows messages to avoid the effect that the application "is not responding".
FRPages

Find

Remove

 Renamed The new names of the methods are IndexOf, DeleteAt. Methods of all collections have been renamed to be uniform.
DocumentInformationDictionary

Add

CreateDocumentInformationDictionaryItem

Insert

 Renamed Use the AddNew method instead. Methods of all collections have been renamed to be uniform.
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.
AuthorsList

Add

CreateAuthorInfo

 Renamed Use the AddNew method instead. Methods of all collections have been renamed to be uniform.

Remove

RemoveAll

 Renamed The new names of the methods are DeleteAt, DeleteAll. Methods of all collections have been renamed to be uniform.

17.09.2024 15:14:40

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.