SetItemText Method (LISTVIEW)


PLBCMP GUI Only

 

The SetItemText method changes the text of an item within a LISTVIEW object. The method uses the following format:

 

[label]

{object}.SetItemText

[GIVING {return}] USING [*Index=]{index}:

 

 

[*Text=]{text}[,[*Subitem=]{subitem}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A LISTVIEW object that is modified.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

index

Required. A decimal number or Numeric Variable that specifies the zero-based item or row to modify.

text

Required. A Character String Variable or literal that specifies the label associated with the item or sub-item.

subitem

Optional. A decimal number or Numeric Variable that specifies the item to modify.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. {sub-item} specifies that the text is to associate with a child item of {index}. If not given, zero is assumed and the text of the item label is set.

  2. Upon completion, {return} will contain the status of the modification as follows. $TRUE and $FALSE are defined in PLBEQU.INC.

  3.  

    Value

    Constant

    The modification ...

    0

    $FALSE

    failed.

    1

    $TRUE

    was successful.

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

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

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

 

 

See Also: Example Code, Method Syntax, LISTVIEW Methods

 



PL/B Language Reference SetItemState Method (LISTVIEW) SetItemTextAll (LISTVIEW)