SetActiveControl Method

Give the focus to a control on the active form.

App.ActiveForm.SetActiveControl(Control)

Client support

   Newlook Smartclient

   Newlook Server

Limited support in Newlook Server - see Use section below.

Parameters

Control - (Object, Required)

Specifies the control that is to be given focus when the form is loaded. The control can be referenced using either its name or its index within the controls collection.

Returns

Returns a Boolean indicating the success or failure of the method.

Use

This method can be used to set the focus to a specific control on the form.

By default, Newlook gives focus to the first entry capable field sent through in the 5250 data stream. The SetActiveControl method can be used to change the control that receives focus to something other than the default, this is especially useful on screens where the fields have been rearranged to conform with business work flow requirements, or for validation purposes.

The SetActiveControl method can not be called until after a host form has been received, therefore it cannot be called via the OnReceive or OnRefresh event properties of a form. Instead the OnTimer event property must be used if you want to set a custom active control when the form is first displayed.

BE AWARE THAT:

Newlook Server does not support the OnTimer event - therefore this method has limited applications in Server and can only be called via a user-initiated event property, such as the OnClick property or OnChange property of a control.

Examples

The following example will set the focus to a control named MyControl: VB SCRIPT Sub SetInitialFocus 'Set the focus to the control named MyControl SetFocusSuccess = App.ActiveForm.SetActiveControl (App.ActiveForm.Controls.MyControl)   If SetFocusSuccess = False Then App.MsgBox "Alert", "The field you are navigating to does not exist on the screen." End If End Sub

Give the focus to a control on the master form.

App.ActiveForm.SetActiveControl(App.MasterForm.Control)

Client support

   Newlook Smartclient

   Newlook Server

Limited support in Newlook Server - see Use section below.

Parameters

Control - (Object, Required)

Specifies the control that is to be given focus when the form is loaded. The control can be referenced using either its fully qualified name or its index within the Master Form's controls collection.

Returns

Returns a Boolean indicating the success or failure of the method.

Use

This method can be used to set the focus to a specific control on the current master form.

NOTE:

It is important to use a fully qualified name in the control parameter of this method when setting focus to an object on the master form. If "App.MasterForm." is left out, Newlook will assume the default, which is the active client form.

BE AWARE THAT:

Newlook Server does not support the OnTimer event - therefore this method has limited applications in Server and can only be called via a user-initiated event property, such as the OnClick property or OnChange property of a control.

Examples

The following example will set the focus to a control, cbLanguageOptions, on the master form: VB SCRIPT Sub SetFocusToMasterForm 'Set the focus to a control named cbLanguageOptions on the masterform App.ActiveForm.SetActiveControl ( App.MasterForm.cbLanguageOptions) End Sub