WinGetTransparent

Returns the degree of transparency of the specified window.

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

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. 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 or String (empty)

This function returns a number 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.

The return value is an empty string in the following cases:

Error Handling

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

Remarks

To set transparency, use WinSetTransparent.

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

WinSetTransparent, WinGetTransColor, Win functions, Control functions

Examples

Retrieves the degree of transparency of the window under the mouse cursor.

MouseGetPos ,, &MouseWin
TransDegree := WinGetTransparent(MouseWin)