ControlGet()

OutputVar := Mfunc.ControlGet(Cmd [, Value, Control, WinTitle, WinText, ExcludeTitle, ExcludeText])

Mfunc.ControlGet(Cmd [, Value, Control, WinTitle, WinText, ExcludeTitle, ExcludeText])

Retrieves various types of information about a control.

Parameters

Cmd, Value

See list below.

Control

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, 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 ControlGet Hwnd, MouseGetPos, or DllCall.

WinTitle

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

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.

Returns

Returns the results of cmd.

Throws

Throws MfException if error occurs.

Remarks

Wrapper for AutoHotkey Docs - ControlGet.
Static Method
Any and/or all parameter for this function can be instance of MfString or var containing string.

See Also:AutoHotkey Docs - ControlGet

Example

OutputVar := Mfunc.ControlGet("Line", 1, "Edit1", "Some Window Title")

try {
	WhichTab := Mfunc.ControlGet("Tab", , "SysTabControl321", "Some Window Title")
	MsgBox Tab #%WhichTab% is active.
} catch e {
	MsgBox There was a problem.
}