WinGetTransparent

Returns the degree of transparency of the specified window.

Transparent := WinGetTransparent(WinTitle, WinText, ExcludeTitle, ExcludeText)

Parameters

WinTitle

Type: String, Integer or Object

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

WinText

Type: String

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

Type: String

Windows whose titles include this value will not be considered.

ExcludeText

Type: String

Windows whose text include this value will not be considered.

Return Value

Type: Integer

This function returns an integer between 0 and 255 representing the degree of transparency of the specified window, where 0 indicates an invisible window and 255 indicates an opaque window (see WinSetTransparent for how to set transparency). The return value is an empty string if: 1) there are no matching windows; 2) the window has no transparency level; or 3) other conditions (caused by OS behavior) such as the window having been minimized, restored, and/or resized since it was made transparent.

Error Handling

An exception is thrown if the window could not be found.

Remarks

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

Window titles and text are case sensitive. Hidden windows are not detected unless DetectHiddenWindows has been turned on.

Related

WinSetTransparent, WinGetTransColor, Win functions, Control functions

Examples

#1: Retrieves the transparency of a window under the mouse cursor:

MouseGetPos ,, MouseWin
Transparent := WinGetTransparent(MouseWin)