WinGetControls

Retrieves the control names for all controls in a window. If no matching window exists or there are no controls in the window, OutputVar is made blank. Otherwise, each control name consists of its class name followed immediately by its sequence number (ClassNN), as shown by Window Spy.

OutputVar := WinGetControls(WinTitle, WinText, ExcludeTitle, ExcludeText)

Controls := WinGetControls("ahk_class Notepad")

WinGetControls, OutputVar [, WinTitle, WinText, ExcludeTitle, ExcludeText]

WinGetControls, Controls, ahk_class Notepad

Parameters

OutputVar

The name of the variable in which to store an array containing control names.

WinTitle

The title or partial title of the target window (the matching behavior is determined by SetTitleMatchMode). If this and the other 3 window parameters are blank or omitted, the Last Found Window will be used. To use a window class, specify ahk_class ExactClassName (shown by Window Spy). To use a process identifier (PID), specify ahk_pid %VarContainingPID%. To use a window group, specify ahk_group GroupName. To use a window's unique ID number, specify ahk_id %VarContainingID%. The search can be narrowed by specifying multiple criteria. For example: My File.txt ahk_class Notepad. The use correct child window when multiple window with same criteria exist specify ahk_parent %VarContainingID%. For example: ahk_class #32770 ahk_parent %MyWinID%

WinText

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

Windows whose titles include this value will not be considered.

ExcludeText

Windows whose text include this value will not be considered.

Remarks

Controls are sorted according to their Z-order, which is usually the same order as TAB key navigation if the window supports tabbing. Hidden windows are included only if DetectHiddenWindows has been turned on.

Examples

for i,ClassNN in WinGetControls("ahk_class Notepad")
  MsgBox % "ClassNN: " ClassNN