SetColumnText Method (LISTVIEW)


PLBCMP GUI Only

 

The SetColumnText method modifies the text label of a column within a LISTVIEW object. The method uses the following format:

 

[label]

{object}.SetColumnText

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

 

 

[*Text=]{text}

 

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 column to modify.

text

Required. A Character String Variable that specifies the new label for the column.

Flags Affected: EOS, OVER, ZERO

Note the following:

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

  2.  

    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 unless needed.

 

 

See Also: Method Syntax, LISTVIEW Methods

 



PL/B Language Reference SetColumnOrder Method (LISTVIEW) SetColumnWidth Method (LISTVIEW)