ClientAreaObject - cCJCommandBarSystem

Returns the handle of the ClientArea object associated with the command bar

Type: Function
Return Data Type: Handle

Syntax

Function ClientAreaObject Returns Handle

Call Example

Get ClientAreaObject to HandleVariable

Description

ClientAreaObject returns the handle of the ClientArea object associated with the command bar. If the commandbar system is not being used as the main MDI menu system or if no ClientArea object exists, this will return zero.

It is expected that a ClientArea object will be a sibling of the commandbar system object.

Procedure OnExecute Variant vCommandBarControl
    Handle hoCommandBars hoClientArea
    Get CommandBarSystemObject to hoCommandBars
    Get ClientAreaObject of hoCommandBars to hoClientArea
    If hoClientArea Begin
        Send Switch_Next_View of hoClientArea
    End
End_Procedure

Return Value

Returns the handle of the ClientArea object, zero if no such object exists.