This object represents a single “image plane” (black-and-white, gray, color or preview) of an open image. It gives a user access to properties of this “image plane,” such as its geometrical parameters and resolution.
In Windows , the Image object allows you to get a bitmap handle corresponding to this image.
Properties
| Name | Type | Description |
|---|
| Application | Engine, read-only | Returns the Engine object. |
| Height | int, read-only | Stores the height of the current image plane in pixels. The heights of the black-and-white, gray, and color image planes of an image are equal. |
| ImageColorType | ImageColorTypeEnum, read-only | Specifies the color type for the current image plane (black-and-white, gray, color). <Note> By agreement on the ABBYY FineReader Engine API, if the ImageDocument object represents black-and-white image, an image plane received from IImageDocument::ColorImage property will actually be of black-and-white color type. This property provides information about actual color type of the current image plane. </Note> |
| Width | int, read-only | Stores the width of the current image plane in pixels. The widths of the black-and-white, gray, and color image planes of an image are equal. |
| XResolution | int, read-only | Stores the horizontal resolution of the current image plane in pixels per inch. The resolutions of the black-and-white, gray, and color image planes of an image are equal. |
| YResolution | int, read-only | Stores the vertical resolution of the current image plane in pixels per inch. The resolution of the black-and-white, gray, and color image planes of an image are equal. |
Methods
| Name | Description |
|---|
| EstimateBitmapSize | Estimates the size of the bitmap that will be returned by the GetBitmap method. <Note> Windows only. </Note> |
| GetBitmap | Returns a handle of bitmap that corresponds to the current image plane. <Note> Windows only. </Note> |
| WriteToFile | Writes the image of the current image plane into an image file. |
Object Diagram
This object is the input parameter of the IMultipageImageWriter::AddPage method.
Samples
The object is used in the following code samples:
See also
ImageDocument
Working with Images
Working with Properties 