SetItem Method (TREEVIEW)


PLBCMP GUI Only

 

The SetItem method changes the information stored for an item in a TREEVIEW object. The method uses the following format:

 

[label]

{object}.SetItem

[GIVING {return}] USING [*Item=]{item}[:

 

 

[*Text=]{text}][,[*Image=]{image}][:

 

 

[*SelImage=]{selimage}][,[*Param=]{param}]

 

Where:

label

Optional. A Program Execution Label.

object

Required. A TREEVIEW object that is modified.

return

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

item

Required. A decimal number or Numeric Variable that indicates the handle of the item to modify.

text

Optional. A Character String Variable or literal that specifies the new text associated with the item.

image

Optional. A decimal number or Numeric Variable that specifies an IMAGELIST index for normal display.

selimage

Optional. A decimal number or Numeric Variable that specifies an IMAGELIST index to display when selected.

param

Optional. A decimal number or Numeric Variable that specifies a user-defined value.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. Only the information given in the method is changed.

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

  3. If {return} is too small to contain result of the method, the OVER Condition Flag is set.

  4. The EOS Condition Flag is always cleared.

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

  6.  

    Value

    Constant

    The association ...

    0

    $FALSE

    failed.

    1

    $TRUE

    was successful.

 

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

 

 

See Also: Method Syntax, TREEVIEW Methods

 



PL/B Language Reference SetImageList Method (TREEVIEW) SetItemCheck Method (TREEVIEW)