InsertTab Method (TABCONTROL)

PLBCMP GUI Only, 9.4C

The InsertTab method adds or inserts tabs into a TABCONTROL object. The method uses the following format:

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 inserted.

label

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

image

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

param

Optional. A decimal number or Number Variable whose value is user defined.

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. The {return} value is the index position of tab when it was successfully inserted. If the InsertTab method fails, the {return} value is 0xFFFFFFFF.

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