ControlGetItems

Returns an array of entries from a list box, combo box, or drop-down list.

Items := ControlGetItems(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.

Return Value

Type: Array

This function returns an array containing the text of each entry.

Error Handling

A TargetError is thrown if the window or control could not be found, or if the control's class name does not contain "Combo" or "List".

An Error is thrown on failure, such as if a message returned a failure code or could not be sent.

Remarks

This function 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.

Some applications store their control data privately, preventing AutoHotkey from retrieving any text. In such cases, no exception is usually thrown, but all the retrieved text will be empty.

To get the total number of entries, use Array.Length, as in example #3. To instead discover how many pages exist in a tab control, follow this example:

PageCount := SendMessage(0x1304,,, "SysTabControl321", WinTitle)  ; 0x1304 is TCM_GETITEMCOUNT.

ListViewGetContent, WinGetList, Control functions

Examples

Accesses the entries of a combo box one by one in a GUI or non-GUI window.

for entry in ControlGetItems("ComboBox1", "Some Window Title")
    MsgBox "Entry number " A_Index " is " entry

Accesses a specific entry of a list box by index in a GUI or non-GUI window.

entries := ControlGetItems("ListBox1", "Some Window Title")
MsgBox "The first item is " entries[1]
MsgBox "The last item is " entries[-1]

Reports the total number of entries in a list box within a GUI or non-GUI window.

entries := ControlGetItems("ListBox1", "Some Window Title")
MsgBox "The total number is " entries.Length