SubItemHitTest Method (LISTVIEW)

PLBCMP GUI Only

The SubItemHitTest method retrieves the item and sub item number in a LISTVIEW object for a given point on the screen. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object that is accessed.

return

Optional. A Numeric Variable that returns the zero-based item or sub item number.

horz

Required. A decimal number or Numeric Variable that specifies the horizontal position to test.

vert

Required. A decimal number or Numeric Variable that specifies the vertical position to test.

mask

Optional. A decimal number or Numeric Variable that alters the behavior of the method as described below.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. Upon completion, {return} will contain a -1 if the method failed.

2. If the method succeeds and the {mask} value is not used, the {return} is the item number times one hundred (100) plus the sub item number. If the method succeeds and the {mask} value has the low order bit set to one (1), the {return} value is the item number times one thousand (1000) plus the sub item number.

3. If the value returned is zero, the ZERO condition flag is set.

4. The OVER and EOS Condition Flags are always cleared.

5. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

6. This method is not available when using the PL/B Web Server.

See Also: Method Syntax, LISTVIEW Methods