Parameter Objects Compatibility with Version 10

PageProcessingParams

DetectInvertedImage

DetectOrientation

OrientationDetectionParams

RemoveGeometricalDistortions

Removed

Use the CorrectInvertedImage, CorrectOrientation, OrientationDetectionParams, CorrectGeometry properties of the PagePreprocessingParams subobject. There is a new stage concerned with image preprocessing, and settings used at that stage were grouped into a separate object to make the structure of parameters objects clearer and more logical.

PerformPageAnalysis

Renamed

Use the PerformAnalysis property to enable layout analysis and PerformPreprocessing property to enable correction of page orientation, inversion, and geometrical distortions. The image preprocessing stage has been separated from page analysis and has its own set of parameters.

BarcodeParams

DetectBarcodes

Removed

Use the corresponding properties of the PageAnalysisParams subobject. Many processing parameters were grouped into subobjects to make the structure of parameters objects clearer and more logical.

BarcodeParams

PDF417CodePage

Renamed

The new name of the property is CodePage. This property can be used for barcodes of several types besides PDF417.

PageAnalysisParams

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.

DetectLanguage

Removed

Use the LanguageDetectionMode property to manage automatic detection of recognition languages.

TextLanguage

An attribute of the property has been 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 and were deprecated in the previous version. 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.

WritingStyleEnum

WS_Default

Removed

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.

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

AddRecognizedTextFontName

GetRecognizedTextFontName

CleanRecognizedTextFontNames

RecognizedTextFontCount

AdjustRecognizedTextFonts

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

This property had no effect on the program operation. If you want to save recognition information, use the SaveCharacterRecognitionVariants or SaveWordRecognitionVariants property of the RecognizerParams object.

SynthesisParamsForPage

InsertEmptyParagraphsForBigInterlines

Removed

Use the ITextExportParams::RetainLayout property to emulate the original text layout with the help of spaces.

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.

FontFormattingDetectionParams

Type changed

The property provides access to the FontFormattingDetectionParams object. The parameters of font formatting detection at the stage of page synthesis and document synthesis are the same now. Formerly different parameters were used for font detection on page level to speed up document synthesis, and page font detection had to be less thorough to be quick. Now the same font detection is available for page synthesis without speed loss.

However, note that if the document has similar style and fonts for all pages, the results of font detection on document level are still more reliable than on pages one-by-one.

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.

FontFormattingDetectionParamsForPage

Removed

This object is no longer in use. Use the FontFormattingDetectionParams object instead. The parameters of font formatting detection at the stage of page synthesis and document synthesis are the same now. Formerly different parameters were used for font detection on page level to speed up document synthesis, and page font detection had to be less thorough to be quick. Now the same font detection is available for page synthesis without speed loss.

FontFormattingDetectionParams

DetectMonospace

Removed

Use the MonospaceDetectionMode property instead. If you do not want monospaced typeface to be detected, set the MonospaceDetectionMode property to MDM_Ignore.

ProcessingParams

Renamed

Use the DocumentProcessingParams object instead. The object provides the same functionality with the following exceptions:

• The SynthesisParamsForPage property of the old object has been moved to the PageProcessingParams subobject.
• The signature of the Windows SaveToMemory method has been changed.

ObjectsExtractionParams

FlexiFormsDA

Removed

This property is obsolete since FineReader Engine 11. Use the EnableAggressiveTextExtraction property instead.

FullTextIndexDA

Removed

This property is obsolete since FineReader Engine 11. Use the DetectTextOnPictures property of the PageAnalysisParams instead.

SourceContentReuseMode

Default value changed

The default value of this property is now CRM_Auto. This setting uses both the text and the image layer of the PDF file and ensures the highest quality of objects extraction.

ErrorHiliteLevelEnum

Removed

The property which used this enumeration has been removed.

HTMLExportParams

PictureFormat

PictureJpegQuality

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 HTML export format: write running titles as plain text or not write them at all.

WriteAuthor

WriteKeywords

WriteSubject

WriteTitle

Removed

Use the corresponding properties of the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property). This is a new object containing all necessary parameters for saving the metadata properties of the document.

EncodingType

Behavior changed

The default value of this property is still TET_Auto, but the behavior of this constant has changed:

• for FEF_HTMLVersion10Defaults encoding is selected automatically, as in 10th version; if encoding could not be successfully determined, UTF-8 encoding is used. This setting is retained for compatibility with the previous version and will be removed in future.
• for FEF_HTMLUnicodeDefaults it is TET_UTF8. This setting is recommended.

PPTExportParams

PictureFormat

PictureJpegQuality

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.

WriteAuthor

WriteKeywords

WriteSubject

WriteTitle

Removed

Use the corresponding properties of the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property). This is a new object containing all necessary parameters for saving the metadata properties of the document.

RTFExportParams

PictureFormat

PictureJpegQuality

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.

KeepPages

Removed

Use the KeepPageBreaks property instead.

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. This new object contains the page size parameters. An important feature is that it allows two automatic modes of page size selection: selecting the size separately for each page and selecting one of the standard paper sizes so that all pages in the document fit it.

WriteAuthor

WriteKeywords

WriteSubject

WriteTitle

Removed

Use the corresponding properties of the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property). This is a new object containing all necessary parameters for saving the metadata properties of the document.

KeepTextAndBackgroundColor

Removed

Use the KeepTextColor and BackgroundColorMode properties instead. You can now set these two parameters separately.

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. It was deprecated in the previous version of ABBYY FineReader Engine.

PSM_RTFColumns

Removed

Use the PSM_RTFEditableCopy constant instead.

TextExportParams

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.

ExportParagraphsAsOneLine

Behavior changed

The value of this property is ignored if the RetainLayout property is TRUE. This new property turns on the layout emulation mode, and line breaks are always kept in this mode.

InsertEmptyLineBetweenParagraphs

Behavior changed

The value of this property is ignored if the RetainLayout property is TRUE. This new property turns on the layout emulation mode, and the presence of empty lines is determined by the size of empty space between paragraphs in the original.

EncodingType

Default value changed

By default, the value of this property is TET_Auto:

• when the export format is specified by the FEF_TextVersion10Defaults constant, this property resolves into TET_Simple — effectively the same behavior as in 10th version and only retained for compatibility;
• when the export format is specified by the FEF_TextUnicodeDefaults constant, this property resolves into TET_UTF8. This setting is recommended.

XLExportParams

RetainLayout

Removed

Use the LayoutRetentionMode property instead.

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.

WriteAuthor

WriteKeywords

WriteSubject

WriteTitle

Removed

Use the corresponding properties of the DocumentContentInfoWritingParams subobject (available via the MetaDataWritingParams property). This is a new object containing all necessary parameters for saving the metadata properties of the document.

FileExportFormatEnum

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

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.

FEF_Text

Renamed

The new name of this constant is FEF_TextVersion10Defaults. It is provided for compatibility only.

We recommend using the new FEF_TextUnicodeDefaults constant, which ensures that the default encoding for the exported text will be UTF-8. This encoding is the most universal choice.

FEF_HTML

Renamed

The new name of this constant is FEF_HTMLVersion10Defaults. It is provided for compatibility only.

We recommend using the new FEF_HTMLUnicodeDefaults constant, which ensures that the default encoding for the exported text will be UTF-8. This encoding is the most universal choice.

TextEncodingTypeEnum

TET_Auto

Behavior changed

• for ITextExportParams::EncodingType this constant resolves into TET_Simple if the export format constant was FEF_TextVersion10Defaults and into TET_UTF8 if the export format constant was FEF_TextUnicodeDefaults;
• for IHTMLExportParams::EncodingType this constant means automatic encoding selection if the export format constant was FEF_HTMLVersion10Defaults (but if encoding is not successfully determined, UTF-8 is used), and TET_UTF8 if the export format constant was FEF_HTMLUnicodeDefaults.

ExportPictureFormatEnum

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.

RunningTitleModeEnum

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.

RTFPageOrientationEnum

Renamed

The new name of the enumeration is PageOrientationEnum. This enumeration is used to set page orientation for various export formats besides RTF.

AltoExportParams

FontAttributesMode

Renamed

The new name of the property is FontFormattingMode. “Font formatting” is the phrase generally used elsewhere in FineReader Engine API.

EBookExportParams

PictureFormat

PictureJpegQuality

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.

FontAttributesMode

Renamed

The new name of the property is FontFormattingMode. “Font formatting” is the phrase generally used elsewhere in API.

FontAttributesModeEnum

Renamed

The new name of the enumeration is FontFormattingModeEnum. “Font formatting” is the phrase generally used elsewhere in API.

XMLExportParams

WriteNondeskewedCoordinates

Default value changed

By default, the value of this property is TRUE.

PDFColorityModeEnum

Renamed

The new name of the enumeration is PictureColorityModeEnum. This enumeration is used for setting picture colority for several export formats.

PDFExportFeatures

WriteMetaDataToXmp

Renamed, type changed

This property is now called WriteXmpMetadata and is of ThreeStatePropertyValueEnum type. By default, the program determines automatically if metadata should be written.

RunningTitleMode

Removed

Use the WriteRunningTitles boolean property instead. There are only two options for PDF export format: write running titles as plain text or not write them at all.

EmbedFonts

Removed

Use the FontEmbeddingMode property instead. The default value of the new property is set to automatic selection of font embedding mode, which means that fonts are embedded to PDF/A files, and are not embedded to PDF files.

WriteTaggedPDF

Type changed

This property is now of ThreeStatePropertyValueEnum type. By default, the program determines automatically if the PDF file should be tagged, based on the level of PDF/A compliance.

FontMode

Removed

This property is obsolete. Use the FontSet property of the SynthesisParamsForDocument object instead. The FontSet 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.

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.

PDFPictureCompressionParams

ColorFormat

GrayFormat

BwFormat

Removed

Use the ColorPictureFormats, GrayPictureFormats, BwPictureFormats properties instead. Each of these properties is a bitwise OR of constants of corresponding enumerations, and can be set to automatic selection of picture format.

JpegQuality

Default value changed

The new default value of the property is 45%.

PDFMRCParams

BackgroundQuality

ColorMaskQuality

Removed

Use the JpegQuality property of the PDFPictureCompressionParams object.

TextMaskQuality

Removed

The text mask quality cannot be specified directly. You can set the quality of black-and-white image via the BwPictureFormats property of the PDFPictureCompressionParams object.

BackgroundFormat

ColorMaskFormat

TextMaskFormat

Removed

The formats cannot be specified directly for different planes. Use the ColorPictureFormats, GrayPictureFormats, BwPictureFormats properties of the PDFPictureCompressionParams object to specify formats of the color, gray, or black-and-white image.

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.

PicturesInBackground

Renamed, type changed

This property is now called ProcessPicturesAsBackground and is of the ThreeStatePropertyValueEnum type. By default, pictures are not treated as part of the background.

ColorMaskDownSampling

Default value changed

The new default value of the property is 4.

CompressionLevel

Removed

This functionality is no longer supported. 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. To set exact MRC settings, use other properties of the object.

TextMaskDownSampling

Removed

This functionality is no longer supported. Down sampling rate of text mask cannot be specified in this version.

PDFEncryptionInfo

CopyFrom

Removed

The method is obsolete and is no longer in use. The EncryptionInfo is a read-only property of PDFExportFeatures object. Another object cannot be assigned to this property. If you need to modify the encryption settings, pass a reference to this property to a new variable, and then use this variable to change necessary properties.

UseAES

Removed

Use the EncryptionAlgorithm property to select the encryption type.

PDFExportParamsOld

PDFAExportParamsOld

Removed

These objects are obsolete. Use the PDFExportParams object instead. See below the equivalence between the properties of the objects (property of PDFExportParamsOld (PDFAExportParamsOld) — corresponding property of PDFExportParams):

• EmbedFonts — use the PDFFeatures property (IPDFExportFeatures::FontEmbeddingMode)
• EnableMRC — MRCMode
• 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)
• WriteAuthor — the PDFFeatures property (IPDFExportFeatures::MetaDataWritingParams, WriteAuthor property)
• WriteCreator — the PDFFeatures property (IPDFExportFeatures::MetaDataWritingParams, WriteCreator property)
• WriteKeywords — the PDFFeatures property (IPDFExportFeatures::MetaDataWritingParams, WriteKeywords property)
• WriteLinks — the PDFFeatures property (IPDFExportFeatures::WriteLinks)
• WritePDFA1A — PDFAComplianceMode (set the property to PCM_Pdfa_1a to export to PDF/A-1a format)
• WriteProducer — the PDFFeatures property (IPDFExportFeatures::MetaDataWritingParams, WriteProducer property)
• WriteSubject — the PDFFeatures property (IPDFExportFeatures::MetaDataWritingParams, WriteSubject property)
• WriteTaggedPDF — the PDFFeatures property (IPDFExportFeatures::WriteTaggedPDF)
• WriteTitle — the PDFFeatures property (IPDFExportFeatures::MetaDataWritingParams, WriteTitle property)

PDFPaperSizeParams

SetPageSizeByLayoutSize

SetPageSizeByOriginalImageSize

Renamed

Use the PaperSizeParams object instead. This object differs from the previous one in the following aspects:

• SetPageSizeByLayoutSize, SetPageSizeByOriginalImageSize — use the IPaperSizeParams::PaperSizeMode property instead.

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.

MultiProcessingParams

SharedCPUCoresMode

Removed

To use CPU cores in shared mode, you should set the IsSharedCPUCoresMode parameter of the InitializeEngine function to TRUE during initialization.

If you need shared core usage, setting this mode at initialization time is safer. Formerly, the cores were loaded as isolated and then transferred to shared, which could cause problems when starting several applications at once.

SharedCPUCoresMask

Type changed

The property has the __int64 type.

This change has been made for 64-bit operating systems support.