ControlFocus()

Auto Hotkey

ControlFocus

Sets input focus to a given control on a window.

ControlFocus Control, WinTitle, WinText, ExcludeTitle, ExcludeText
Command  example: ControlFocus "Edit1", "MyGui ahk_class AutoHotkeyGUI"
Function example: ControlFocus("Edit1", "MyGui ahk_class AutoHotkeyGUI")

Parameters

Control (optional)

Can be either ClassNN (the classname and instance number of the control) or the control's text, both of which can be determined via Window Spy. When using text, the matching behavior is determined by SetTitleMatchMode. If this parameter is blank or omitted, the target window's topmost control will be used.

To operate upon a control's HWND (window handle), leave the Control parameter blank and specify ahk_id %ControlHwnd% for the WinTitle parameter (this also works on hidden controls even when DetectHiddenWindows is Off). The HWND of a control is typically retrieved via ControlGetHwnd, MouseGetPos, or DllCall.

WinTitle (optional)

A window title or other criteria identifying the target window. See WinTitle.

WinText (optional)

If present, this parameter must be a substring from a single text element of the target window (as revealed by the included Window Spy utility). Hidden text elements are detected if DetectHiddenText is ON.

ExcludeTitle (optional)

Windows whose titles include this value will not be considered.

ExcludeText (optional)

Windows whose text include this value will not be considered.

ErrorLevel

ErrorLevel is set to 1 if there was a problem or 0 otherwise.

Remarks

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

To improve reliability, a delay is done automatically after every use of this command. That delay can be changed via SetControlDelay.

To discover the ClassNN or HWND of the control that the mouse is currently hovering over, use MouseGetPos.

Window titles and text are case sensitive. Hidden windows are not detected unless DetectHiddenWindows has been turned on.

Related

SetControlDelay, ControlGetFocus, Control functions, ControlMove, ControlGetPos, ControlClick, ControlGetText, ControlSetText, ControlSend

Example

ControlFocus, OK, Some Window Title  ; Set focus to the OK button