WinGetTransColor

Returns the color that is marked transparent in the specified window.

TransColor := WinGetTransColor(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: String

This function returns the six-digit RGB color such as 0x00CC99 that is marked transparent in the specified window (see WinSetTransColor for how to set the TransColor). The return value is an empty string if: 1) there are no matching windows; 2) the window has no transparency color; 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

WinSetTransColor, WinGetTransparent, Win functions, Control functions

Examples

#1: Retrieves the transparent color of a window under the mouse cursor:

MouseGetPos ,, MouseWin
TransColor := WinGetTransColor(MouseWin)