This property returns the format of a page.
Namespace:
Kofax.OmniPageCSDK.IproPlusAssembly:
Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntaxpublic IMF_FORMAT Format(
[OptionalAttribute] int Page
)
Public Function Format (
<OptionalAttribute> Page As Integer
) As IMF_FORMAT
public:
IMF_FORMAT Format(
[OptionalAttribute] [InAttribute] int Page
)
Parameters
- Page (Optional)
- Type: SystemInt32
Return Value
Type:
IMF_FORMAT
Remarks
Available formats are listed under the IMF_FORMAT Enumeration topic.
The optional Page parameter is a number defining the index of the page being queried. If it is not specified or (-1), the format of the first page will be returned.
The format of any two pages in a multi-page image may be different only in the compression method.
See Also