Skip to main content
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

NameTypeDescription
PageProcessingParamsPageProcessingParamsSpecifies the processing parameters for each page of the document.
PerformSynthesisVARIANT\_BOOLSpecifies if document synthesis is to be performed. If this property is FALSE, the SynthesisParamsForDocument property is ignored. This property is TRUE by default.
SynthesisParamsForDocumentSynthesisParamsForDocumentSpecifies the synthesis parameters for the document.

​
Methods

NameDescription
CopyFromInitializes properties of the current object with values of similar properties of another object.
LoadFromFileRestores the object contents from a file on disk.
LoadFromMemory <Note> : Windows only. </Note>Restores the object contents from the global memory.
SaveToFileSaves the object contents into a file on disk.
SaveToMemory <Note> : Windows only. </Note>Saves the object contents into the global memory.
DocumentProcessingParams 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: DocumentProcessingParams_VC

​
Samples

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:

​
See also

Tuning Parameters of Preprocessing, Analysis, Recognition, and Synthesis Working with Properties