DocumentProcessingParams Object (IDocumentProcessingParams Interface)

DocumentProcessingParams object (IDocumentProcessingParams interface) in the ABBYY FineReader Engine API — Aggregates all parameters that affect document processing (page processing plus document-synthesis parameters); passed to document processing methods; persistent object savable to file/memory.

This object provides access to all parameters that affect document processing including all parameters of page processing and synthesis parameters for document. This object is passed as a parameter to the document processing methods.

The DocumentProcessingParams object is a persistent object. This means that the object’s current state can be written to persistent storage. Later, the object can be re-created by reading the object’s state from the persistent storage. The following methods provide persistence of the object:

Linux: SaveToFile, and LoadFromFile

Windows SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.

Properties

Name	Type	Description
PageProcessingParams	PageProcessingParams	Specifies the processing parameters for each page of the document.
PerformSynthesis	VARIANT_BOOL	Specifies if document synthesis is to be performed. If this property is FALSE, the SynthesisParamsForDocument property is ignored. This property is TRUE by default.
SynthesisParamsForDocument	SynthesisParamsForDocument	Specifies the synthesis parameters for the document.

Methods

Name	Description
CopyFrom	Initializes properties of the current object with values of similar properties of another object.
LoadFromFile	Restores the object contents from a file on disk.
LoadFromMemory Note: Windows only.	Restores the object contents from the global memory.
SaveToFile	Saves the object contents into a file on disk.
SaveToMemory Note: Windows only.	Saves the object contents into the global memory.

Related objects

Object Diagram

Output parameter

This object is the output parameter of the CreateDocumentProcessingParams method of the Engine object.

Input parameter

This object is passed as an input parameter to the following methods:

• Process, ProcessPages methods of the FRDocument object
• RecognizeImageFile, InjectTextLayer methods of the Engine object

Related Visual Components

Samples

C# code

FREngine.IEngine engine;
FREngine.IFRDocument frdoc;
// We presume that the document has been created and images have been added to the document
// Create DocumentProcessingParams and set parameters
FREngine.IDocumentProcessingParams dpp = engine.CreateDocumentProcessingParams();
FREngine.IPageProcessingParams ppp = dpp.PageProcessingParams;
ppp.PagePreprocessingParams.CorrectOrientationMode = COM_No;
// Use the parameters for processing
frDoc.Process( dpp );

The object is used in the following code samples:

• Linux: CustomLanguage
• Windows: CustomLanguage, VisualComponents (Win); and demo tools: MultiProcessingRecognition, PDFExportProfiles.

See also

Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis

Working with Properties