GetTopIndex Method (LISTVIEW)


9.0F, PLBCMP GUI Only

 

The GetTopIndex method retrieves the topmost visible item number for a LISTVIEW object when in a list or report view. The method uses the following format:

 

[label]

{object}.GetTopIndex

[GIVING {return}]

 

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 value or a failure value.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. Upon completion, {return} will contain a -1 value when there are no items for a LISTVIEW object.

  2. The {return} value is always set to zero if the LISTVIEW is in the icon or small icon view.

  3. If the value returned is zero, the ZERO Condition Flag is set.

  4. If {return} is too small to contain the item count, the OVER Condition Flag is set.

  5. The EOS Condition Flag is always cleared.

 

 

See Also: Method Syntax, LISTVIEW Methods

 



PL/B Language Reference GetStringWidth Method (LISTVIEW) GetXMLDataSize Method (LISTVIEW)