ControlChooseString

Sets the selection in a ListBox or ComboBox to be the first entry whose leading part matches the specified string.

ControlChooseString String, Control , WinTitle, WinText, ExcludeTitle, ExcludeText

Parameters

String

Type: String

The string to choose. The search is not case-sensitive. For example, if a ListBox/ComboBox contains the item "UNIX Text", specifying the word unix (lowercase) would be enough to select it.

Control

Type: String, Integer or Object

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

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; however, when using pure HWNDs, hidden windows are always detected regardless of DetectHiddenWindows. By default, a window title can contain WinTitle or ExcludeTitle anywhere inside it to be a match, unless changed with SetTitleMatchMode.

Return Value

Type: Integer

This function returns the index of the chosen item, where 1 is the first item, 2 is the second, etc.

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 or OSError is thrown if the change could not be applied.

Remarks

Unlike GuiControl.Choose(), this function raises a Change or DoubleClick event.

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.

ControlChooseIndex, ControlGetChoice, Choose method (GuiControl object), Control functions