ControlGetPos

Retrieves the position and size of a control.

ControlGetPos &OutX, &OutY, &OutWidth, &OutHeight, ControlID, WinTitle, WinText, ExcludeTitle, ExcludeText

Parameters

&OutX, &OutY

Type: VarRef

If omitted, the corresponding value will not be stored. Otherwise, specify references to the output variables in which to store the Integer X and Y coordinates (in pixels) of the control's upper left corner. These coordinates are relative to the upper-left corner of the target window's client area (which is the area not including title bar, menu bar, and borders) and thus are the same as those used by ControlMove.

Controls inside nested containers use the same target-window origin. If ControlID is a HWND or an object with a Hwnd property, the window criteria are ignored and the containing top-level window supplies the client-area origin. A top-level window uses its own client-area origin.

&OutWidth, &OutHeight

Type: VarRef

If omitted, the corresponding value will not be stored. Otherwise, specify references to the output variables in which to store the control's Integer width and height (in pixels).

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. If omitted, the target window itself is used. A child target's position is reported relative to its containing top-level window's client area. A top-level target uses its own client area, so a window with a frame can have negative X and Y coordinates.

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.

Error Handling

A TargetError is thrown if the window or control could not be found.

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

Unlike functions that change a control, ControlGetPos does not have an automatic delay (SetControlDelay does not affect it).

Linux

Position queries are supported for the script's own toolkit controls. Controls in foreign applications are not supported.

macOS

Position queries are supported for the script's own toolkit controls. These coordinate changes await macOS runtime verification.

Related

ControlMove, WinGetPos, GuiControl.GetPos, Control functions

Examples

Loop
{
    Sleep 100
    MouseGetPos ,, &WhichWindow, &WhichControl
    try ControlGetPos &x, &y, &w, &h, WhichControl, WhichWindow
    ToolTip WhichControl "`nX" X "`tY" Y "`nW" W "`t" H
}