DEOFocusObject - cBaseLocalControlHost

Returns the object handle of the object representing the currently focused control on the client if the control supports the data entry object interface

Type: Function
Return Data Type: Handle

Syntax

Function DEOFocusObject Returns Handle

Call Example

Get DEOFocusObject to HandleVariable

Description

Call DEOFocusObject to return the DataFlex object handle of the server-side object that represents the currently focused object on the client.

Data Entry Objects (DEOs) support the Server property to attach the object to a server DataDictionary object (DDO). The data entry object (DEO) interface includes all Request_Save, Request_Find, Request_Delete and Request_Clear messages that are processed by the attached Server DataDictionary object (DDO).

Control classes such as cWebForm and cWebColumn are examples of classes that support the data binding message interface. Container classes such as cWebCard, cWebPanel and cWebView support the DEO interface, but not the full data binding interface (see DEOControlFocusObject for more information).

Use DEOFocusObject when you want to send a message that is part of the DEO interface, to the focused object. DEOFocusObject can be used in the OnClick event of a menu item or toolbar button (cWebMenuItem) to send some message to the object that had the focus when the menu item was selected.

Sample

This sample sends Request_Find to the focus object, but only if the focused object supports the Request_Find (and other data binding messages).

Procedure OnClick
    Handle hoFocus
    Get DEOFocusObject to hoFocus
    If hoFocus Begin
        Send Request_Save of hoFocus
    End
End_Procedure

Return Value

The DataFlex object handle of the server-side object that represents the currently focused object on the client. If the DataFlex object does not support the data entry object message interface, then 0 is returned.