$DoVerb Method (CONTAINER)

PLBCMP GUI Only

The $DoVerb method performs an action for a CONTAINER object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A CONTAINER within which the method is activated.

return

Optional. A Numeric Variable that indicates the success or failure of the method.

verb

Required. A decimal number or Numeric Variable that specifies a verb from the table below.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. The {verb} must be one of the following values or keyword as defined in PLBMETH.INC:
    

Value	Keyword	Action
0	OLEPrimary	The default action for the object.
-1	OLEShow	Activates the object for editing.
-2	OLEOpen	Opens the object in a separate application window.
-3	OLEHide	For embedded objects, hides the application that created the object.
-4	OLEUIActivate	If the object supports in-place activation, activates it and shows any user interface tools.
-5	OLEInPlaceActivate	If the user moves the focus to the OLE container control, creates a window for the object and prepares the object for editing.
-6	OLEDiscardUndoState	When the object is activated for editing, discards all record of changes that the object's application can undo.

 

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

 

Value	Constant	The method ...
0	$FALSE	failed.
1	$TRUE	was successful.

 

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

4. The OVER and EOS Condition Flags are always cleared.

5. For improved performance in the Application Server environment, do not specify the optional return value unless needed.

See Also: Method Syntax, CONTAINER Methods