ControlGetIndex

Returns the index of the currently selected entry in a list box, combo box, or drop-down list, or the index of the active page in a tab control.

Index := ControlGetIndex(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: Integer

This function returns the index of the currently selected list entry or active tab page. The first entry or page is 1, the second is 2, and so on. If no entry is selected or no page is active, the return value is 0.

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", "List" or "Tab".

An OSError is thrown if a message could not be sent to the control.

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.Value.

ControlChooseIndex, ControlGetChoice, ControlChooseString, GuiControl.Value, GuiControl.Choose, Control functions

Examples

Reports the index of the active page in the first tab control of a GUI or non-GUI window.

WhichTab := ControlGetIndex("SysTabControl321", "Some Window Title")
MsgBox "Tab #" WhichTab " is active."