PrepareImageMode Object (IPrepareImageMode Interface)
This object contains different attributes specifying how an image will be prepared during conversion to the internal format. All properties of a newly created object of this type are set to reasonable defaults. To know about the default value of this or that property, see its description. The sequence of the transformations upon the prepared image is the following: first the rotation is performed, and then the image is mirrored.
The PrepareImageMode object is a persistent object. This means that the object's current state can be written to persistent storage: an area in the global memory or a disk file. Later, the object can be re-created by reading the object's state from persistent storage. The following methods provide persistence of the object: SaveToFile, LoadFromFile, SaveToMemory, and LoadFromMemory.
Properties
| Name | Type | Description |
|---|---|---|
| Application | Engine, read-only | Returns the Engine object. |
| CompressImage | ThreeStatePropertyValueEnum |
Specifies if the image should be compressed during conversion to the internal format. Only color and gray images may be compressed. ZIP compression is used. By default, this property is set to TSPV_Auto, which currently means that only the gray or color images obtained from PDF files with text layer will be compressed. |
| DocumentType | DocumentTypeEnum |
Specifies the type of the document on the image. If you know the document type for certain, you can set this property to bypass the document classifier and save time. By default, this property is DT_Auto, which means that FineReader Engine should run the document classifier to determine document type. |
| ImageSourceType | ImageSourceTypeEnum |
Specifies the image origin. For example, a photo and a screenshot with some text will need different preprocessing techniques. By default, this property is IST_Auto, which means that FineReader Engine should detect the image origin automatically. |
| OfficeConversionSettings | OfficeConversionSettings, read-only | Provides access to the settings for importing digital documents using the same methods that open the images. |
| RasterizeFreeText | VARIANT_BOOL |
Specifies whether Free Text annotations from the input PDF document should be retained. By default, this property is set to TRUE. |
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 | Restores the object contents from the global memory. |
| SaveToFile | Saves the object contents into a file on disk. |
| SaveToMemory | Saves the object contents into the global memory. |
Related objects
Output parameter
This object is the output parameter of the CreatePrepareImageMode method of the Engine object.
Input parameter
This object is passed as an input parameter to the following methods:
- AddImageFile, AddImageFileFromAttachment, AddImageFileWithPassword, AddImageFileWithPasswordCallback, AddImageFileFromMemory methods of the FRDocument object
- Start method of the BatchProcessor object
- CreateFRDocumentFromImage, PrepareBitmapBits, OpenImageFileFromMemory, OpenBitmapBits, OpenBitmap, OpenDib, PrepareBitmap, PrepareDib, InjectTextLayer methods of the Engine object
Samples
The object is used in the following code samples: CommandLineInterface; and demo tools: Engine Predefined Processing Profiles.
See also
07.11.2025 12:48:30