Deactivate - cUIObject

Removes the object from the focus tree

Type: Procedure

Return Data Type: Integer

Parameters: Integer eDeactivateScope

ParameterDescription
eDeactivateScopeMode which determines which object is deactivated. Modes can be:

ConstantMeaning
Popup_Type Searches for object with popup_state set to true
Scope_Type Searches for object with scope_state set to true
Area_Type Searches for object with scope_state or popup_state set to true


Return Value

If the deactivate operation is not successful, returns a non-zero value according to the error conditions


Syntax
Procedure Deactivate Integer eDeactivateScope Returns Integer

Call: Get msg_Deactivate eDeactivateScope to IntegerVariable


Description

The Deactivate message removes the object from the focus tree and, if successful, sends the Deactivating message. If the receiver has objects in its Next_Level in the focus tree, those objects are deactivated before the current object.

The eDeactivateScope parameter determines what object will actually be deactivated. If this parameter is omitted, or equals zero (0), the receiver of the message is deactivated. However, if eDeactivateScope is non-zero, the focus tree is searched "upward" (through prior_levels) for an object to deactivate based on the eDeactivateScope.


See Close_Panel for detailed explanations of the View and Modal Dialog deactivation process.


Get msg_Deactivate of (oMenu(Self)) to iRetVal
Get msg_Deactivate Area_Type to iRetVal


If the deactivate operation is not successful, a non-zero value is returned according to the following error conditions:

1 Error_Entering Entering (of new focus) returned a non zero value
2 Error_Exiting Exiting returned a non zero value or one the objects in the next_level of the object refused to deactivate
4 Error_Deactivating Deactivating returned a non zero value