ImageFile Class |
Namespace: Kofax.OmniPageCSDK.IproPlus
The ImageFile type exposes the following members.
Name | Description | |
---|---|---|
![]() | AlwaysOpen |
Use this property to get or set whether the image file is kept open or not as long as the related ImageFile exists. |
![]() | FileName |
This property returns path of the image file.
|
![]() | Name |
Use this property to get or set a name for the image file. |
![]() | PageCount |
This property returns the number of pages stored in the associated image file. |
![]() | UniqueID |
This property returns the unique ID of the object.
|
Name | Description | |
---|---|---|
![]() | AppendPage |
This method appends one or more pages to the image file from the image file specified by the SrcImage parameter. |
![]() | Clear |
This method clears the specified area of one or all pages in the image file. |
![]() | Convert2BW |
This method can be used to convert one or more pages of the image file to black-and-white (bi-tonal, one-bit color depth). |
![]() | CreateMemoryBitmap |
This method creates a MemoryBitmap object from one of the pages stored in the related ImageFile
object. |
![]() | CreateMemoryBitmapArea |
This method creates a MemoryBitmap object from a defined area in one of the pages specified by the Page parameter stored in the
related ImageFile object. |
![]() | CreatePage |
This method creates an empty page based on the information specified by the Info parameter. |
![]() | CreatePageFromBitmap |
This method creates an empty page using the memory bitmap specified by the Bitmap parameter. |
![]() | DeletePage |
This method deletes the page specified by the Page parameter from the image file. |
![]() | Deskew |
This method de-skews a page by an amount given by the Slope parameter. |
![]() | Deskew3D |
This method performs 3-dimensional de-skew on a page, which means it is used to correct the skew and perspective distortion that can
occur when an image is taken by digital camera. |
![]() | Despeckle |
This method performs adaptive noise removal on a B/W page. |
![]() | DetectSkew |
This method attempts to detect the orientation and the slope of a page. |
![]() | Dispose | Releases all resources used by the ImageFile |
![]() | Equals | (Overrides ObjectEquals(Object).) |
![]() | Format |
This property returns the format of a page. |
![]() | GetEngine |
Returns the Engine object.
|
![]() | GetHashCode | (Overrides ObjectGetHashCode.) |
![]() | GetPalette |
This property is used to get or set the palette of an 8-bit page in the image file object. |
![]() | Info |
This property creates and returns an ImageInfo object for the requested page of the image file. |
![]() | InsertPage |
This method inserts one or more pages into the image file from the image file specified by the SrcImage parameter at the position specified by the Page parameter. |
![]() | Invert |
This method inverts the specified area of one or all pages in the image. |
![]() | IsBlank |
This method returns True if the page identified with the optional Page index parameter is a blank image. |
![]() | Pack |
When this method is called the data from any pages deleted using ImageFile methods such as DeletePage are physically
removed from the image file. |
![]() | Paletted |
This method returns True if the requested page is a paletted, color one. |
![]() | RemoveLines |
This method removes the vertical and horizontal lines from the specified part of a BW page and returns a RemovedLines collection
containing the removed lines. |
![]() | Rotate |
This method rotates one or more pages of the image file according to the Rotation parameter. |
![]() | SaveArea |
This method saves a part of the page image to a new file using an image format specified by the Format parameter. |
![]() | SaveAs |
This method saves the image to a new file using the specified format. |
![]() | SetPalette |
This method sets the palette of an image's page.
|
![]() | Transform |
This method transforms one or more pages of the image file. |
![]() | TransformByMatrix |
This method performs a geometric transformation on a page of the image file using the passed transformation matrix. |
![]() | TransformByPoints |
This method performs a geometric transformation on a page. |
![]() | TransformPalette |
This method transforms one or more pages of the image file. |
![]() | UpdatePage |
This method updates a single page specified by the Page index parameter with a new image at the index SrcPage, stored in the image file defined by the SrcImage parameter. |
![]() | UpdatePageFromBitmap |
This method replaces a page in the image file with the content specified by the Bitmap parameter. |
Use this object to get information on, manipulate or convert image files using a wide set of image manipulation methods. Most image-processing methods are available only for particular multi-page tiff images as documented in the descriptions for the methods concerned. To process other images using these methods, save them in the multi-page TIFF format first, perform the operations and convert them back to the original format.
The supported image resolution is in the range of 75-2400 dpi. When accessing bitmap pixel data, note that every stored image is stored in bottom-up line order and the pixel order is BGR.