Page.RecommendUserZone Method
|
This method locates a likely user zone based on a coordinate giving a location on the page.
Namespace:
Kofax.OmniPageCSDK.IproPlus
Assembly:
Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntaxpublic ZONETYPE RecommendUserZone(
int x,
int y,
out IPRORECT Rect
)
Public Function RecommendUserZone (
x As Integer,
y As Integer,
<OutAttribute> ByRef Rect As IPRORECT
) As ZONETYPE
public:
ZONETYPE RecommendUserZone(
[InAttribute] int x,
[InAttribute] int y,
[OutAttribute] IPRORECT% Rect
)
Parameters
- x
- Type: System.Int32
- y
- Type: System.Int32
- Rect
- Type: Kofax.OmniPageCSDK.IproPlus.IPRORECT
Return Value
Type:
ZONETYPE
Remarks
The engine analyzes the environment around the co-ordinate specified by the X and Y parameters and returns a user zone
recommendation in the Rect parameter if a likely one is found.
The return value is the zone type, whose available values are documented in the description of the Type property of
the UserZone object.
If no recommended user zone was found by the engine, the Rect output value returns Null-Rect and WT_IGNORE is returned by the method.
See Also