SetTabImage Method (TABCONTROL)

PLBCMP GUI Only, 9.4C

The SetTabImage method set, replace, or remove an image index for a tab for 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 is the image index value that is assigned to the specified tab.

index

Required. A decimal number or Numeric Variable whose value identifies the tab to be accessed.

image

Required. A decimal number or Number Variable whose value identifies the image index in the imagelist that has been set for the TABCONTROL.

Flags Affected: EOS, OVER, ZERO

Note the following:

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

2. If the execution of the SetTabImage method is successful, the {return} value is non-zero. If the method fails, the {return} value is zero.

3. If the execution of the method is successful, the {return} value is the index value of an image in the imagelist that is set for the TABCONTROL object.

4. The {index} is a zero relative numeric value that identifies the TABCONTROL tab.

5. The {image} is a zero relative numeric value that specifies the image from the TABCONTROL imagelist to be set for the tab. If the {image} is a value of 0xFFFFFFFF, the image is removed from the TABCONTROL tab.

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

7. The EOS Condition Flag are always cleared.

See Also: Method Syntax, TABCONTROL Methods