SetTab Method (TABCONTROL)


PLBCMP GUI Only, 9.4C

 

The SetTab method sets or changes the label or image for tabs into a TABCONTROL object. The method uses the following format:

 

[label]

{object}.SetTab

[GIVING {return}]:

 

 

USING [*Index=]{index}:

 

 

[*Label=]{label}:

 

 

[*Image=]{image}

 

Where:

label

Optional. A Program Execution Label.

object

Required. A TABCONTROL object that is accessed.

return

Optional. A Numeric Variable whose value indicates the success or failure of this method.

index

Required. A decimal number or Numeric Variable whose value identifies the position of the tab to be changed.

label

Optional. A Character String Variable or literal that is the label for the tab being changed.

image

Optional. A decimal number or Number Variable whose value identifies the image index in the imagelist.

Flags Affected: EOS, OVER, ZERO

Note the following:

  1. The {index} is a zero relative value.

  2. If both the {label} and {image} parameters are not provided, this method does nothing.

  3. If the method executes successfully, the {return} value is non-zero. If the method fails, the {return} value is zero.

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

  5. The OVER Condition Flag is set if the {return} value is too large to be stored without truncation.

  6. The EOS Condition Flag are always cleared.

 

 

See Also: Method Syntax, TABCONTROL Methods

 



PL/B Language Reference SetStyle Method (TABCONTROL) SetTabImage Method (TABCONTROL)