WinSetAlwaysOnTop

Makes the specified window stay on top of all other windows (except other always-on-top windows).

WinSetAlwaysOnTop NewSetting, WinTitle, WinText, ExcludeTitle, ExcludeText

Parameters

NewSetting

Type: Integer

If omitted, it defaults to 1. Otherwise, specify one of the following values:

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.

Error Handling

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

An OSError may be thrown on failure.

Remarks

The ID of the window under the mouse cursor can be retrieved with MouseGetPos.

WinMoveTop, WinMoveBottom, Win functions, Control functions

Examples

Toggles the always-on-top status of the calculator.

WinSetAlwaysOnTop -1, "Calculator"