ControlFocus

Sets keyboard focus to a control.

ControlFocus ControlID , WinTitle, WinText, ExcludeTitle, ExcludeText

Parameters

ControlID

Type: String, Integer or Object

The control's ClassNN, text or HWND, or an object with a Hwnd property. For details, see Control Identifiers.

WinTitle, WinText, ExcludeTitle, ExcludeText

Type: String, Integer or Object

If each of these is blank or omitted, the Last Found Window will be used. Otherwise, specify for WinTitle a window title or other criteria to identify the target window and/or for WinText a substring from a single text element of the target window (as revealed by the included Window Spy utility).

ExcludeTitle and ExcludeText can be used to exclude one or more windows by their title or text. Their specification is similar to WinTitle and WinText, except that ExcludeTitle does not recognize any criteria other than the window title.

Window titles and text are case-sensitive. By default, hidden windows are not detected and hidden text elements are detected, unless changed with DetectHiddenWindows and DetectHiddenText. When using pure HWNDs, hidden windows are always detected. By default, a window title can contain WinTitle or ExcludeTitle anywhere inside it to be a match, unless changed with SetTitleMatchMode.

Error Handling

A TargetError is thrown if the window or control could not be found.

Remarks

This function is intended for use with controls in a non-GUI window, i.e. a window that is not created with the Gui function. It works best with common or predefined Microsoft controls; some applications use custom or modified controls, in which case the function might not work as expected. For GUI controls, it is usually more convenient to use GuiControl.Focus.

To be effective, the control's window generally must not be minimized or hidden.

To improve reliability, a delay is done automatically after each use of this function. That delay can be changed via SetControlDelay or by assigning a value to A_ControlDelay. For details, see SetControlDelay remarks.

When a control is focused in response to user input, such as pressing Tab, the dialog manager applies additional effects which are independent of the control having focus. These effects are not applied by ControlFocus, and therefore the following limitations apply:

The WM_NEXTDLGCTL message can be used to focus the control and apply these additional effects. For example:

WinExist("A") ; Set the Last Found Window to the active window.
hWndControl := ControlGetHwnd("Button1")  ; Get HWND of the first button.
SendMessage 0x0028, hWndControl, True  ; 0x0028 is WM_NEXTDLGCTL.

SetControlDelay, ControlGetFocus, GuiControl.Focus, Control functions

Examples

Sets keyboard focus to the OK button in a GUI or non-GUI window.

ControlFocus "OK", "Some Window Title"