Skip to main content
The ABBYY FineReader Engine functionality is implemented in a number of objects that provide methods for working with images, page layout and blocks, languages and recognized text. The interfaces of the ABBYY FineReader Engine objects are derived from IDispatch, that is they support early and late binding.
NameDescription
AltoExportParamsProvides functionality for tuning parameters of recognized text export in ALTO format.
AuthorInfoRepresents an item of an authors list of a FB2 or EPUB file.
AuthorsListRepresents a list of authors (AuthorInfo objects) of an FB2 or EPUB file.
AutoAnalysisBlock <Note> Windows only. </Note>Provides access to the properties of an autoanalysis block. These blocks are used only in Visual Components.
BarcodeBlockProvides access to specific properties of the barcode block.
BarcodeParamsAllows you to tune the parameters of barcode block recognition.
BarcodeSymbolProvides access to the properties of one character of a recognized barcode.
BarcodeTextRepresents a text of a recognized barcode as a collection of characters.
BaseLanguageRepresents a base recognition language.
BaseLanguagesThis object is a collection of base languages (BaseLanguage objects).
BatchProcessor <Note> Implemented for Linux and Windows </Note>This is a processor object which converts input images into the recognized pages (FRPage objects).
BlockThis object represents a single block.
BusinessCardProvides access to the recognized data of a business card.
BusinessCardFieldProvides access to a single field of a business card.
BusinessCardFieldComponentProvides access to a component of a business card field.
BusinessCardSynthesisParamsThis object is used for setting up the parameters of the business card synthesis.
BusinessCardsRepresents a collection of BusinessCard objects.
CategoriesA collection of Category objects.
CategoryA set of classification objects belonging to the same category.
ChangeA single comparison result which contains the data about the detected change in the document or page.
ChangeLocationProvides information about the location of the change.
ChangePositionRepresents the place in the document where a change begins or ends.
ChangesA collection of Change objects.
CharacterRecognitionVariantThis object represents a variant of a character’s recognition.
CharacterRecognitionVariantsThis object represents a collection of variants of a character’s recognition (CharacterRecognitionVariant objects).
CharParamsAllows you to access different parameters of a single character in the recognized text.
CheckmarkBlockThis object provides access to specific properties of a checkmark block.
CheckmarkGroupThis object exposes methods and properties for working with a group of checkmarks.
CheckmarkTrainingDataContains information on checkmark training.
ClassificationEngineThe main object which provides access to Classification API of ABBYY FineReader Engine.
ClassificationObjectContains classification-relevant data extracted from a document or a page.
ClassificationObjectsA collection of ClassificationObject objects.
ClassificationResultA single classification result, consisting of the category name and the probability that the object which was classified belongs to this category.
ClassificationResultsA collection of ClassificationResult objects.
ColorObjectsProhibitingParamsUsed for tuning parameters of filtering out the color objects on the image before starting processing.
ConfusionMatrixThe confusion matrix for a classification model.
ComparatorThe main object which provides access to Document Comparison API of ABBYY FineReader Engine.
ComparisonParamsThis object provides access to the comparison parameters.
ComparisonResultRepresents the result of comparison of the original document or page with its copy and exports it to an XML or DOCX file.
CoordinatesConverterContains information about the pixel coordinates on the image at a definite modification stage.
DetectedLanguageRepresents a single language from the collection of languages detected in the recognized document or on the recognized page.
DetectedLanguagesThis object is a collection of recognition languages detected in the recognized document or on the recognized page. (DetectedLanguage objects).
DictionaryThis object is designed for working with user-defined dictionaries.
DictionaryDescriptionThis object is a dictionary description which may be typecast to one of its child objects: StandardDictionaryDescription, UserDictionaryDescription or RegExpDictionaryDescription.
DictionaryDescriptionsThis object is a collection of dictionaries.
DocumentContentInfoThis object contains information about author, keywords, subject, title of the document and stores document information dictionary.
DocumentInformationDictionaryRepresents a document information dictionary which contains metadata from the PDF file.
DocumentInformationDictionaryItemThis object is an element of a document information dictionary.
DocumentProcessingParamsProvides access to all parameters of document processing: all parameters of page processing and parameters of document synthesis.
DocumentStructureDetectionParamsThis object is used for setting up the parameters of the document structure detection during document synthesis.
EBookExportParamsProvides access to the parameters of recognized text export in FB2 and EPUB formats.
EmptyPageDetectionParamsAllows you to tune the parameters of empty page detection with the help of the FRPage::IsEmpty method.
EngineThis is the main ABBYY FineReader Engine object.
EnumDictionaryWordsServes for iterating words included in a user-defined dictionary.
ExportFileWriter<Warning> This object is deprecated and will be removed in future versions. </Warning> This is an interface for incremental export to PDF.
ExternalDictionaryCallbackThis is a callback interface which is used to deliver information about dictionary words to the recognizer.
ExternalDictionaryDescriptionProvides access to an external dictionary.
FontFormattingDetectionParamsThis object is used for setting up the parameters of font formatting detection.
FontStyleExposes properties of a font style.
FRDocumentCorresponds to a document which may contain several pages.
FRPageCorresponds to a page of document.
FRPagesThis object is a collection of document pages.
FRRectangleRepresents a location and size of a rectangle.
FuzzyStringRepresents a fuzzy string.
FuzzyStringsCollection of the FuzzyString objects.
HandleProvides access to the handle of a resource in memory.
HTMLExportParamsProvides functionality for tuning parameters of recognized text export in HTML format.
HyperlinkThis object represents a hyperlink.
IAsyncProcessingCallback <Note> Linux and Windows only. </Note>This is a callback interface that is used for managing the work of the BatchProcessor object and reporting errors, occurred during processing. This interface is implemented on the client-side.
IEngineLoader <Note> Windows only. </Note>This interface is used specifically to load and unload the Engine object.
IExternalDictionaryThis is a user-implemented interface for external dictionary.
IFileAdapter <Note> Linux and Windows only. </Note>This is the interface for a file adapter.
IFileWriterThis is the interface for a file writing stream.
IFRDocumentEventsThis is a callback interface that is used for reporting events from the FRDocument object to the listeners.
IFRPageEventsThis is a callback interface that is used for reporting events from the FRPage object to the listeners.
IFRPagesEventsThis is a callback interface that is used for reporting events from the FRPages object to the listeners.
IHostProcessControl <Note> Windows only. </Note>This interface can be used to manage the process which hosts FineReader Engine.
IImageDocumentEventsThis is a callback interface that is used for reporting events from the ImageDocument object to the listeners.
IImagePasswordCallbackThis is a callback interface that is used for processing password-protected image files.
IImageSource <Note> Linux and Windows only. </Note>This is the interface for a custom source of images.
ILicensingConnectionRecoveryCallback <Note> Linux and Windows only. </Note>This is a callback interface for handling the breaks of connection to the license server.
ImageThis object represents a single “image plane” of an open image.
ImageDocumentThis object corresponds to an open image.
ImageModificationThis object is used to store parameters of image modification.
ImageProcessingParamsSpecifies how an image will be preprocessed before analysis and recognition.
InprocLoader <Note> Windows only. </Note>Allows you to load ABBYY FineReader Engine as an in-process server into the current process.
IntsCollectionCollection of int type variables.
IParallelProcessingCallback <Note> Linux and Windows only. </Note>This is a callback interface that is used for managing the parallel processing work and reporting errors which occurred during the processing.
IProcessingEventsThis is a callback interface that is used by the InjectTextLayer method of the Engine object to report events during processing.
IReadStreamThis is the interface for a read stream.
IWriteStreamThis is the interface for a write stream.
IScanCallback <Note> Windows only. </Note>This is a callback interface that is used for managing scanning operations.
JpegExtendedParamsThis object is used to store parameters for saving images in JPEG format.
JsonExportParamsProvides functionality for tuning parameters of recognized text export in JSON format.
LanguageDatabaseProvides means for performing advanced operations with recognition languages.
LayoutExposes methods and properties for working with the image layout.
LayoutBlocksThis object represents a collection of blocks (Block objects).
LicenseProvides access to the current license parameters.
LicensesProvides access to a collection of available (activated) licenses.
ListRepresents one list template. It is a collection of list levels (ListLevel objects).
ListLevelProvides access to the parameters of one level of a list.
ListParamsProvides access to the parameters of the list to which a paragraph belongs.
ModelRepresents a trained model which can be used for classifying documents.
MrzDataRepresents the data extracted from a machine-readable zone (MRZ) and exports it to an XML file or JSON file.
MrzFieldContains the information about a field extracted from a machine-readable zone (MRZ).
MrzJsonExportParamsProvides functionality for tuning parameters of the captured machine-readable zone (MRZ) export in JSON format.
MrzLineContains the information about a line extracted from a machine-readable zone (MRZ).
MrzProcessingParamsProvides access to parameters of the machine-readable zone (MRZ) extraction.
MrzXmlExportParamsProvides functionality for tuning parameters of the captured machine-readable zone (MRZ) export in XML format.
MultipageImageWriterThis object is used for saving several images into a single image file.
MultiProcessingParams <Note> Linux and Windows only. </Note>Provides access to the parameters of multiple CPU cores usage.
ObjectsExtractionParamsProvides access to parameters used for objects extraction.
OfficeConversionSettings <Note> Linux and Windows only. </Note>Represents the settings used to import digital documents.
OfficeConverters <Note> Linux and Windows only. </Note>A collection of types of applications which may be used to convert digital documents.
OutprocLoader <Note> Windows only. </Note>Allows you to load ABBYY FineReader Engine as an out-of-process server into a separate process.
PageAnalysisParamsProvides access to parameters used for tuning the page layout analysis process.
PageMarginsProvides functionality for tuning page margins of the output file.
PagePreprocessingParamsThis object is used for tuning different parameters of page preprocessing.
PageProcessingParamsThis object is used for tuning different parameters of layout analysis, recognition, and page synthesis.
PaperSizeParamsProvides functionality for tuning paper height and width of the output file.
ParagraphExposes methods and properties for working with a single paragraph of the recognized text.
ParagraphLineRepresents a single line in the paragraph of a recognized text.
ParagraphLinesRepresents a collection of paragraph lines.
ParagraphParamsThis object exposes extended properties of a single paragraph.
ParagraphsThis object represents collection of paragraphs of the recognized text.
ParagraphStyleExposes properties of the paragraph style.
PDFAttachmentThis object represents a PDF attachment.
PDFAttachmentsThis object represents a collection of PDF attachments of a document.
PDFEncryptionInfoThis object provides access to encryption parameters of the PDF file during export.
PDFExportFeaturesProvides functionality for tuning the additional parameters of export to PDF (PDF/A) format: encryption information, PDF version, etc.
PDFExportParamsProvides functionality for tuning parameters of recognized text export in PDF (PDF/A) format.
PDFMRCParamsProvides functionality for tuning Mixed Raster Content (MRC) parameters of the PDF (PDF/A) file during export.
PDFPictureThis object represents a picture from a PDF document.
PDFPicturesThis object represents a collection of pictures added to a PDF document.
PDFPictureCompressionParamsProvides functionality for tuning the parameters of writing images to PDF (PDF/A) files.
PictureChangeProvides the changes that were made in the document pictures.
PictureExportParamsProvides functionality for tuning the parameters of writing images to output files of various formats.
PictureResolutionParamsProvides functionality for tuning the resolution of writing images to output files depending on the image format.
PlainTextRepresents recognized text without formatting.
PngExtendedParamsThis object is used to store parameters used when saving images in PNG format.
PointDescribes the location of a point on an image.
PPTExportParamsProvides functionality for tuning parameters of recognized text export in PPTX format.
PredefinedLanguageRepresents a single predefined recognition language.
PredefinedLanguagesRepresents ABBYY FineReader Engine predefined languages collection.
PrepareImageModeContains different attributes specifying how an image will be prepared during conversion to internal format.
RasterPictureBlockProvides access to specific properties of the raster picture block.
RecognizerParamsAllows you to tune parameters of text recognition.
RegExpDictionaryDescriptionThis object provides access to a regular-expression-based dictionary.
RegionThis supplementary object is designed to store the information on ABBYY FineReader Engine block’s region.
RegionsCollectionCollection of regions (Region objects).
RTFExportParamsProvides functionality for tuning parameters of recognized text export in RTF/DOCX/ODT format.
ScanManager <Note> Windows only. </Note>Exposes a set of properties and methods required to manage the workstation’s scanning sources.
ScanSource <Note> Windows only. </Note>Provides access to scanning source and its methods for scanning.
ScanSourceCapabilities <Note> Windows only. </Note>Provides access to all settings that are supported by the scanning source.
ScanSources <Note> Windows only. </Note>This object is a collection of scanning sources.
ScanSourceSettings <Note> Windows only. </Note>Provides access to the scanning settings of a source.
SeparatorBlockProvides access to specific properties of a separator block.
SeparatorGroupRepresents a group of separator blocks (SeparatorBlock objects).
SortingBlocksParamsThis object is used for setting up the parameters of combining the blocks of data into groups.
SplitRegionProvides access to the properties of one of the regions, into which a page has been split.
SplitRegionsRepresents a collection of regions, into which a page has been split (SplitRegion objects).
StandardDictionaryDescriptionProvides access to a standard dictionary.
StringsCollectionCollection of strings.
SynthesisParamsForDocumentThis object is used for setting up the parameters of the document synthesis.
SynthesisParamsForPageThis object is used for setting up the parameters of the page synthesis.
TableAnalysisParamsProvides access to parameters affecting table block analysis process.
TableBlockProvides access to specific properties of a table block.
TableCellRepresents a single table cell in a table block.
TableCellsRepresents collection of table cells of a table block.
TableSeparatorRepresents a single table separator in a table block.
TableSeparatorsThis object is a collection of table block separators.
TabPositionProvides access to a single tab stop: the tab symbol, its alignment, and position in the paragraph.
TabPositionsProvides access to all the tab stops in a single paragraph.
TextThis object represents recognized text.
TextBlockProvides access to specific properties of the text block.
TextBlockAnalysisParamsSpecifies how a text block should be analyzed.
TextChangeProvides the changes that were made in the document text.
TextExportParamsProvides functionality for tuning parameters of recognized text export in TXT and CSV formats.
TextLanguageRepresents the language of recognition for a text.
TextLayerInjectionParamsThis object allows you to tune the parameters of processing the input documents and creation of a searchable PDF file.
TextOrientationRepresents a text orientation.
TiffExtendedParamsThis object is used to store parameters for saving images in TIFF format.
TrainerThe object which is used for training the classifier on the basis of a categorized data set.
TrainingDataA categorized set of data which can be used to train the classifier.
TrainingImageRepresents a single training image.
TrainingImagesCollectionCollection of TrainingImage objects.
TrainingParamsThe parameters used when training a classification model.
TrainingResultThe result of training the classifier on the set of training data.
TrainingResultsA collection of TrainingResult objects.
UserDictionaryDescriptionThis object provides access to a user dictionary.
ValidationParamsThe parameters used when validating a classification model.
ValidationResultThe result of checking the model’s performance, including the various scores which help to estimate the model’s usefulness.
VectorPictureBlockProvides access to specific properties of a vector picture block.
WordThis object represents a word.
WordRecognitionVariantThis object represents a variant of a word’s recognition.
WordRecognitionVariantsThis object represents a collection of variants of a word’s recognition (WordRecognitionVariant objects).
WordsThis object represents a collection of words (Word objects).
XLExportParamsProvides functionality for tuning parameters of recognized text export in XLS/XLSX format.
XMLExportParamsProvides functionality for tuning parameters of recognized text export in XML format.
XPSExportParamsProvides functionality for tuning parameters of recognized text export in XPS format.

See also

Object Diagram