WinGetStyle / WinGetExStyle

Returns the style or extended style (respectively) of the specified window.

Style := WinGetStyle(WinTitle, WinText, ExcludeTitle, ExcludeText)
ExStyle := WinGetExStyle(WinTitle, WinText, ExcludeTitle, ExcludeText)

Note: No non-Windows platform has a real Win32 style word. For a window created by the script, Keysharp projects the toolkit state onto the WS_* bits: WS_CAPTION or WS_POPUP from the border style, WS_SYSMENU, WS_THICKFRAME, WS_MINIMIZEBOX and WS_MAXIMIZEBOX from the frame buttons, and WS_VISIBLE, WS_DISABLED, WS_MINIMIZE and WS_MAXIMIZE from the window state. Foreign windows expose nothing equivalent: X11 and macOS return 0, and Wayland reports only WS_CAPTION, from the compositor decoration state. WinGetExStyle always returns 0 on Linux and macOS.

Parameters

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

These functions return the style or extended style (respectively) of the specified window.

Error Handling

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

Remarks

See the styles table for a partial listing of styles.

WinSetStyle / WinSetExStyle, ControlGetStyle / ControlGetExStyle, styles table, Win functions, Control functions

Examples

Determines whether a window has the WS_DISABLED style. [v2.1-alpha.1+]: This example is only for illustration because it would be easier to use WinGetEnabled.

Style := WinGetStyle("My Window Title")
if (Style & 0x8000000)  ; 0x8000000 is WS_DISABLED.
    MsgBox "The window is disabled."

Determines whether a window has the WS_EX_TOPMOST style (always-on-top). [v2.1-alpha.1+]: This example is only for illustration because it would be easier to use WinGetAlwaysOnTop.