Win

Set of window functions

Summary
WinSet of window functions
AnimateEnables you to produce special effects when showing or hiding windows.
GetGet window information
GetRectGet window rectangle.
IsChecks handle against specified criterium.
MoveChange the size and position of a child, pop-up, or top-level window.
MoveDeltaMove the window by specified amount.
RecallStore & recall window position, size and/or state.
RedrawRedraws the window.
SetCaptionSet visibility of the window caption.
SetMenuSet the window menu.
SetIconSet the titlebar icon for the window.
SetParentChanges the parent window of the specified window.
SetOwnerChanges the owner window of the specified window.
ShowShow / Hide window.
ShowSysMenuShow system menu for a window (ALT + SPACE menu).
SubclassSubclass child window (control)
About

Animate

Win_Animate(Hwnd,  
Type = "",
Time = 100)

Enables you to produce special effects when showing or hiding windows.

Parameters

TypeWhite space separated list of animation flags.  By default, these flags take effect when showing a window.
TimeSpecifies how long it takes to play the animation, in millisecond .

Animation types

activateActivates the window.  Do not use this value with HIDE flag.
blendUses a fade effect.  This flag can be used only if hwnd is a top-level window.
centerMakes the window appear to collapse inward if HIDE is used or expand outward if the HIDE is not used.  The various direction flags have no effect.
hideHides the window.  By default, the window is shown.
slideUses slide animation.  Ignored when used with CENTER.
hnegAnimates the window from right to left.  This flag can be used with roll or slide animation.  It is ignored when used with CENTER or BLEND.
hposAnimates the window from left to right.  This flag can be used with roll or slide animation.  It is ignored when used with CENTER or BLEND.
vnegAnimates the window from top to bottom.  This flag can be used with roll or slide animation.  It is ignored when used with CENTER or BLEND.
vposAnimates the window from bottom to top.  This flag can be used with roll or slide animation.  It is ignored when used with CENTER or BLEND.

Remarks

When using slide or roll animation, you must specify the direction.  You can combine HPOS or HNEG with VPOS or VNEG to animate a window diagonally.  If a child window is displayed partially clipped, when it is animated it will have holes where it is clipped.  Avoid animating a window that has a drop shadow because it produces visually distracting, jerky animations.

Returns

If the function succeeds, the return value is nonzero.

Example

Win_Animate(hWnd, "hide blend", 500)

Get

Win_Get( Hwnd,  
 pQ = "",
ByRef o1 = "",
ByRef o2 = "",
ByRef o3 = "",
ByRef o4 = "",
ByRef o5 = "",
ByRef o6 = "",
ByRef o7 = "",
ByRef o8 = "",
ByRef o9 = "")

Get window information

Parameters

pQList of query parameters.
o1 .. o9Reference to output variables.  R,L,B & N query parameters can return multiple outputs.

Query

C,IClass, pId.
R,L,B,NOne of the window rectangles: R (window Rectangle), L (cLient rectangle screen coordinates), B (ver/hor Border), N (captioN rect).  N gives size of the caption regardless of the window style.  These coordinates include all title-bar elements except the window menu.  The function returns x, y, w & h separated by space.  For all 4 query parameters you can additionaly specify x,y,w,h arguments in any order (except Border which can have only x(hor) and y(ver) arguments) to extract desired number into ouput variable.
S,EStyle, Extended style
P,A,OParents handle, Ancestors handle, Owners handle
MModule full path (owner exe), unlike WinGet,,ProcessName which returns only name without path.
TTitle for top level windows or Text for child windows

Returns

o1

Examples

Win_Get(hwnd, "CIT", class, pid, text)                  ;get class, pid and text
Win_Get(hwnd, "RxwTC", x, w, t, c)                      ;get x & width attributes of window rect, title and class
Win_Get(hwnd, "RxywhCLxyTBy",wx,wy,ww,wh,c,lx,ly,t,b)   ;get all 4 attributes of window rect, class, x & y of client rect, text and horizontal border height
right := Win_Get(hwnd, "Rx") + Win_Get(hwnd, "Rw")      ;first output is returned as function result so u can use function in expressions.
Win_Get(hwnd, "Rxw", x, w), right := x+w                ;the same as above but faster
right := Win_Get(hwnd, "Rxw", x, w ) + w                ;not recommended

GetRect

Win_GetRect( hwnd,  
 pQ = "",
ByRef o1 = "",
ByRef o2 = "",
ByRef o3 = "",
ByRef o4 = "")

Get window rectangle.

Parameters

hwndWindow handle
pQQuery parameter: ordered list of x, y, w and h characters.  If you specify * as first char rectangle will be raltive to the client area of window’s parent.  Leave pQ empty or “*” to return all attributes separated by space.
o1 .. o4Reference to output variables.

Returns

o1

Remarks

This function is faster alternative to Get with R parameter.  However, if you query additional window info using Get, it may be faster and definitely more convenient then obtaining the info using alternatives.  Besides that, you can’t use Get to obtain relative coordinates of child windows.

Examples

Win_GetRect(hwnd, "xw", x, w)       ;get x & width
Win_GetRect(hwnd, "yhx", y, h, x)   ;get y, height, and x
p := Win_GetRect(hwnd, "x") + 5     ;for single query parameter you don't need output variable as function returns o1
all := Win_GetRect(hwnd)            ;return all
Win_Get(hwnd, "*hx", h, x)          ;return relative h and x
all_rel := WiN_Get(hwnd, "*")       ;return all relative coorinates

Is

Win_Is(Hwnd,  
pQ = "win")

Checks handle against specified criterium.

Parameters

pQQuery parameter.

Query

winTrue if handle is window.
childTrue if handle is child window.
enabledTrue if window is enabled.
visibleTrue if window is visible.
maxTrue if window is maximized.
hungTrue if window is hung and doesn’t respond to messages.

Returns

TRUE or FALSE

Move

Win_Move(Hwnd,  
X = "",
Y = "",
W = "",
H = "",
Flags = "")

Change the size and position of a child, pop-up, or top-level window.

Parameters

X..HSize / position.  You can omit any parameter to keep its current value.
FlagsCan be R or A.

Flags

RDoes not redraw changes.  If this flag is set, no repainting of any kind occurs.
AAsynchronous mode - if the calling thread and the thread that owns the window are attached to different input queues, the system posts the request to the thread that owns the window.  This prevents the calling thread from blocking its execution while other threads process the request.

Returns

True if successful, False otherwise.

Remarks

Does not produce the same effect as ControlMove on child windows.  Mentioned AHK function puts child window relative to the ancestor window rectangle while Win_Move puts it relative to the parent’s client rectangle which is usually the wanted behavior.  WinMove produces the same effect as Win_Move on child controls, except its X and Y parameters are not optional which makes lot of addtional code for frequent operation: moving the control by some offset of its current position.  In order to do that you must get the current position of the control.  That can be done with ControlGetPos which works in pair with ControlMove hence it is not relative to the client rect or WinGetPos which returns screen coordinates of child control so those can not be imediatelly used in WinMove as it positions child window relative to the parents client rect.  This scenario can be additionaly complicated by the fact that each window may have its own theme which influences the size of its borders, non client area, etc...

MoveDelta

Win_MoveDelta(Hwnd,  
Xd = "",
Yd = "",
Wd = "",
Hd = "",
Flags = "")

Move the window by specified amount.

Parameters

Xd ..  HdDelta to add to each window rect property.  Skipped properties will not be changed.
FlagsThe same as in Move.

Returns

True if successful, False otherwise.

Recall

Win_Recall(Options,  
Hwnd = "",
IniFileName = "")

Store & recall window position, size and/or state.

Parameters

OptionsWhite space separated list of options.  See bellow.
HwndHwnd of the window for which to store data or Gui number if AHK window.  If omitted, function will use Hwnd of the default AHK Gui.  You can also use Gui, N:Default prior to calling the function.  For 3td party windows, this parameter is mandatory.  Set 0 as hwnd to return position string without applying it to any window.  This can be used for AHK Guis to calculate size of controls based on window size and position, when needed.
IniFileNameIni file to use as storage.  Function will save the data under the [Recall] section.  If omited, Windows Registry key HKEY_CURRENT_USER\AutoHotKey\Win is used.  Each script is uniquely determined by its full path so same scripts with different name will not share the storage.

Options

”>”, “<”, “-”, “--”Operation, mandatory option.  Use “>” to store or “<” to recall window position.  It can be optionally followed by the string representing the name of the storage location for that window.  You need to use name if your script stores more then one window, otherwise it will be saved under unnamed location.  “>” and “<” are special names that can be used to store or recall all AHK Guis.  “-” operation is used alone as an argument to delete Registry or Ini sections belonging to the script.  “--” operation is used alone as an argument to delete all Registry entries for all scripts.
-MinDon’t save minimize state.
-MaxDon’t save maximized state.

Returns

Position string, space separated list of syntax “left top right bottom state cw ch” of the window.  Empty if no recall data is stored for the window.  State can be 1 (normal) 2 (minimized) or 3 (maximized). cw & ch numbers are present only for AHK Guis and represent client width & height which can be used without modifications in Gui, Show command.

Examples

Single Gui Example:

 Gui, +Resize +LastFound
 WinSetTitle, MyGui
 if !Win_Recall("<")                     ;Recall gui if its position is already saved
    Gui, Show, h300 w300, MyGui         ; otherwise use these defaults.
return

GuiClose:
    Win_Recall(">")                     ;Store the Gui.
    ExitApp
return

Snippets

Win_Recall(">MyGui")                    ;Save position for default Gui under name MyGui.
Win_Recall("<MyGui")                    ;Recall position for MyGui for default Gui

Win_Recall(">MyGui2", Hwnd)             ;Save window position under MyGui2 name, given the window handle or Gui number.
Win_Recall(">>")                        ;Save all Guis. The names will be given by their number.
Win_Recall("<<")                        ;Recall all Guis.

Win_Recall("-")                         ;Delete all Registry enteries for the script.
Win_Recall("--")                        ;Delete all Registry enteries for all scripts.

pos := Win_Recall("<MyWin", 0)          ;Return position string only for window saved under the "MyWin" name.

Redraw

Win_Redraw(Hwnd = )

Redraws the window.

Parameters

HwndHandle of the window.  If this parameter is omited, Redraw updates the desktop window.

Returns

A nonzero value indicates success.  Zero indicates failure.

Remarks

This function will update the window for sure, unlike WinSet or InvalidateRect.

SetCaption

Win_SetCaption(Hwnd,  
Flag = "^")

Set visibility of the window caption.

Parameters

FlagSet + to show the caption or - otherwise.  If omited, caption will be toggled.

SetMenu

Win_SetMenu(Hwnd,  
hMenu = )

Set the window menu.

Parameters

hMenuHandle of the menu to set for window.  By default 0 means that menu will be removed.

Returns

Handle of the previous menu.

SetIcon

Win_SetIcon(Hwnd,  
Icon = "",
Flag = 1)

Set the titlebar icon for the window.

Parameters

IconPath to the icon.  If omited, icon is removed.  If integer, handle to the already loaded icon.
Flag1 sets the large icon for the window, 0 sets the small icon for the window.

Returns

The return value is a handle to the previous large or small icon, depending on the Flag value.

SetParent

Win_SetParent(Hwnd,  
hParent = )

Changes the parent window of the specified window.

Parameters

hParentHandle to the parent window.  If this parameter is 0, the desktop window becomes the new parent window.

Returns

If the function succeeds, the return value is a handle to the previous parent window.

SetOwner

Changes the owner window of the specified window.

Parameters

hOwnerHandle to the owner window.

Returns

Handle of the previous owner.

Remarks

An owned window is always above its owner in the z-order.  The system automatically destroys an owned window when its owner is destroyed.  An owned window is hidden when its owner is minimized.  Only an overlapped or pop-up window can be an owner window; a child window cannot be an owner window.

Show

Win_Show(Hwnd,  
bShow = true)

Show / Hide window.

Parameters

bShowTrue to show (default), False to hide window.

Returns

If the window was previously visible, the return value is nonzero.  If the window was previously hidden, the return value is zero.

ShowSysMenu

Win_ShowSysMenu(Hwnd,  
X = "mouse",
Y = "")

Show system menu for a window (ALT + SPACE menu).

Parameters

X, YCoordinates on which to show menu.  Pass word “mouse” as X (default) to use mouse coordinates.

Returns

True if menu has been shown, False otherwise.

Subclass

Win_Subclass( hCtrl,  
 Fun,  
 Opt = "",
ByRef $WndProc = "")

Subclass child window (control)

Parameters

hCtrlHandle to the child window to be subclassed
FunNew window procedure.  You can also pass function address here in order to subclass child window with previously created window procedure.
OptOptional callback options for Fun, by default “”
$WndProcOptional reference to the ouptut variable that will receive address of the new window procedure.

Returns

The addresss of to the previous window procedure or 0 on error

Remarks

Works only for controls created in the autohotkey process.

Example

if !Win_SubClass(hwndList, "MyWindowProc")
     MsgBox, Subclassing failed.
...
MyWindowProc(hwnd, uMsg, wParam, lParam){

   if (uMsg = .....)
        ; my message handling here

   return DllCall("CallWindowProcA", "UInt", A_EventInfo, "UInt", hwnd, "UInt", uMsg, "UInt", wParam, "UInt", lParam)
}
Win_Animate(Hwnd,  
Type = "",
Time = 100)
Enables you to produce special effects when showing or hiding windows.
Win_Get( Hwnd,  
 pQ = "",
ByRef o1 = "",
ByRef o2 = "",
ByRef o3 = "",
ByRef o4 = "",
ByRef o5 = "",
ByRef o6 = "",
ByRef o7 = "",
ByRef o8 = "",
ByRef o9 = "")
Get window information
Win_GetRect( hwnd,  
 pQ = "",
ByRef o1 = "",
ByRef o2 = "",
ByRef o3 = "",
ByRef o4 = "")
Get window rectangle.
Win_Is(Hwnd,  
pQ = "win")
Checks handle against specified criterium.
Win_Move(Hwnd,  
X = "",
Y = "",
W = "",
H = "",
Flags = "")
Change the size and position of a child, pop-up, or top-level window.
Win_MoveDelta(Hwnd,  
Xd = "",
Yd = "",
Wd = "",
Hd = "",
Flags = "")
Move the window by specified amount.
Win_Recall(Options,  
Hwnd = "",
IniFileName = "")
Store & recall window position, size and/or state.
Win_Redraw(Hwnd = )
Redraws the window.
Win_SetCaption(Hwnd,  
Flag = "^")
Set visibility of the window caption.
Win_SetMenu(Hwnd,  
hMenu = )
Set the window menu.
Win_SetIcon(Hwnd,  
Icon = "",
Flag = 1)
Set the titlebar icon for the window.
Win_SetParent(Hwnd,  
hParent = )
Changes the parent window of the specified window.
Win_Show(Hwnd,  
bShow = true)
Show / Hide window.
Win_ShowSysMenu(Hwnd,  
X = "mouse",
Y = "")
Show system menu for a window (ALT + SPACE menu).
Win_Subclass( hCtrl,  
 Fun,  
 Opt = "",
ByRef $WndProc = "")
Subclass child window (control)
Close