ImageFiles.CreateImageFromPage Method
|
This method creates an
ImageFile object from an existing page stored in another
ImageFile object
and adds it to the collection.
Namespace:
Kofax.OmniPageCSDK.IproPlus
Assembly:
Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntaxpublic void CreateImageFromPage(
string FileName,
IMF_FORMAT Format,
ImageFile Image,
[OptionalAttribute] int Page,
out ImageFile NewImage
)
Public Sub CreateImageFromPage (
FileName As String,
Format As IMF_FORMAT,
Image As ImageFile,
<OptionalAttribute> Page As Integer,
<OutAttribute> ByRef NewImage As ImageFile
)
public:
void CreateImageFromPage(
[InAttribute] String^ FileName,
[InAttribute] IMF_FORMAT Format,
[InAttribute] ImageFile^ Image,
[OptionalAttribute] [InAttribute] int Page,
[OutAttribute] ImageFile^% NewImage
)
Parameters
- FileName
- Type: System.String
- Format
- Type: Kofax.OmniPageCSDK.IproPlus.IMF_FORMAT
- Image
- Type: Kofax.OmniPageCSDK.IproPlus.ImageFile
- Page (Optional)
- Type: System.Int32
- NewImage
- Type: Kofax.OmniPageCSDK.IproPlus.ImageFile
Remarks
This method also returns a reference to the ImageFile object created. The Format parameter specifies the image type as described at
the Format property description of the ImageFile object. If a file with the specified
FileName already exists, it will be overwritten. The page is an optional number - defaulting to 0 - which defines which page of the source Image is copied.
See Also