<< Click to Display Table of Contents >> Navigation:  Interactive Objects > GetFocusControl

Returns the VPE Object which currently owns the focus.

method long VPE.GetFocusControl(

)

Returns:

Returns the Control Handle of the control which currently has the focus.

If no control owns the focus, the ObjectHandle of the returned object is null.

Example:

// The following code retrieves the name of the focused control

// (assuming the control was created from a dycodoc template,

// otherwise controls don't have names assigned to them and an empty string

// is returned)

 

Dim control_name As String

control_name = Doc.GetFocusControl.Name

 

See also:

"Interactive Documents" in the Programmer's Manual.