CONTAINER

PLBCMP GUI Only

The CONTAINER instruction defines a container object variable that enables you to add insertable objects to your program. To define a CONTAINER object, use the following statement format:

Where:

label

Optional. A Data Label.

value

Optional. A string literal that uniquely identifies an interface for an OLE insertable object.

Flags Affected: NONE

Note the following:

1. The CONTAINER object is implemented as an OLE Container Client interface that allows PL/B to server as a container for OLE insertable objects such as an Excel chart.

2. Container objects can be manipulated using the Automation interface.

3. The OLE container object is a placeholder on a form for an OLE insertable object.

4. The object can be created at run time or created with the designer and loaded at runtime.

5. The OLE insertable object can be deleted or changed at runtime.

6. An OLE container object can only contain one OLE insertable object at a time.

7. The size of the {value} literal is truncated to thirty-nine (39) characters.

8. The properties for a CONTAINER object are available as two groups:

• The first group is defined by the normal PL/B property set. These properties are under direct control of the runtime and are defined in the list above.

• The second group of properties is provided only via the Automation interface defined for the CLASS identifier. The user must refer to vendor-supplied documentation for specific properties. The PLBDSIGN browser provides a quick reference to some information.

9. The properties available through the Automation interface use the following syntax:
   
   *{name}={value}
   or
   @{svar}={value}
   
   Where:

label

is a string variable containing the property name. Property names are not case sensitive.

value

is a character variable, numeric variable, VARIANT, or AUTOMATION object that is assigned to the property.

  

10. The PL/B implementation allows event programming. The user should reference the vendor documentation for the OLE Insertable object to determine event values. The PLBDSIGN browse capability retrieves quick reference information about an OLE insertable object.

11. When a CONTAINER object method is used, the method name identifier is determined by referencing the vendor documentation. The method names are not case sensitive. The method can be specified as a keyword form or as a character variable with a leading '@' character. The acceptable syntax forms are as follows
    
    {object}.methodname GIVING {result} USING {param}
    or
    {object}.@{svar} GIVING {result} USING {param]
     

12. The {result} is the expected return value for the method. The variable types for {result} can be a string variable, numeric variable, VARIANT object, or AUTOMATION object. Please reference OLE Insertable objects vendor documentation for expected return values.

13. The object method parameters identify the expected values required for the {method}. The keyword name of a given {param} can be determined from the OLE Insertable object vendor documentation. The {param} keyword names may or may not be used. If the {param} name is not specified, the parameter value must be placed into the {param} list at a valid position as documented for the method. The {param} can have one of the following syntax forms:
    {value}
    or
    *{name}={value}
    or
    @{svar}={value}
    
    Where:

value

is a character variable, numeric variable, VARIANT, or AUTOMATION object that is assigned to the property.

name

is the property name. Property names are not case sensitive.

svar

is a string variable containing the property name. Property names are not case sensitive.

 

14. This object is not available when using the PL/B Web Server.

See Also: Object Definitions, Object Output Instructions