Click or drag to resize

WorkflowViewHitTest Method

Use this function in conjunction with the mouse events detailed in the Events section.

Namespace:  Kofax.OmniPageCSDK.ToolBoxes
Assembly:  Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0
Syntax
Copy
public void HitTest(
	int x,
	int y,
	ref WFVHHITTESTRESULT HitRes,
	ref uint ItemID,
	ref uint SubItemID
)

Parameters

x
Type: SystemInt32
y
Type: SystemInt32
HitRes
Type: Kofax.OmniPageCSDK.ToolBoxesWFVHHITTESTRESULT
ItemID
Type: SystemUInt32
SubItemID
Type: SystemUInt32
Remarks

The x and y parameters are the cursor coordinates to test. The HitResult is an output parameter containing the hit result if any at the given position. The hit result flags and their values are as follows:

Call Value The tested coordinate is...
WFVHT_NOWHERE 0x0000 out of the control's client area.
WFVHT_ON_CLIENT 0x0001 within the control's client area.
WFVHT_ON_STATION_HEAD 0x0002 over a station's head area.
WFVHT_ON_STATION_LABEL 0x0004 over a station's label area.
WFVHT_ON_STATION_BTN 0x0008 over a station's button.
WFVHT_ON_STATION_GRIPPER 0x0010 over a gripper that can be used to reposition stations in mixed mode.
WFVHT_ON_OBJECT_ICON 0x0020 over an object-related icon.
WFVHT_ON_OBJECT_LABEL 0x0040 over an object-related label.
WFVHT_ON_BTN_SCROLL_UP 0x0080 over the up scroll button in vertical station mode.
WFVHT_ON_BTN_SCROLL_DN 0x0100 over the down scroll button in vertical station mode.
WFVHT_ON_BTN_SCROLL_LT 0x0200 over the left scroll button in horizontal station mode.
WFVHT_ON_BTN_SCROLL_RT 0x0400 over the right scroll button in horizontal station mode.

The ItemID and SubItemID output parameters identify the clicked station or object if the coordinate identifies any of them. You can use these values in conjunction with item-related operations.

See Also