Window.ShowOverlay
------------------

Adds an overlay to the window to dark content.

| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
|---|---|---|---|---|---|---|
| [Window](component_Window.md) | [2.3](newinversion23.md) | ✅ Yes | ❌ No | ❌ No | ❌ No | ❌ No |

### Deprecated

This function was [deprecated](deprecated.md).

MBS( "Window.ShowOverlay"; WindowRef; Alpha; Red; Green; Blue ) 

**MBS**( **"Window.ShowOverlay";** /\* Adds an overlay to the window to dark content. \*/  
**$WindowRef**; /\* Window Reference is the unique OS level window ID. You can obtain this by using the [Window.FindByTitle](WindowFindByTitle.md) or [Window.FindByIndex](WindowFindByIndex.md) functions. Pass zero to access the frontmost window.e.g. 0 \*/   
**$Alpha**; /\* The alpha value to use. Range 0.0 (invisible) to 1.0 (full visible). Default 0.5.e.g. 0.5 \*/   
**$Red**; /\* The red color value. Default 0.0.e.g. 0.0 \*/   
**$Green**; /\* The green color value. Default 0.0.e.g. 0.0 \*/   
**$Blue**) /\* The blue color value. Default 0.0.e.g. 0.0 \*/ 

### Parameters

| Parameter | Description | Example |
|---|---|---|
| WindowRef | Window Reference is the unique OS level window ID. You can obtain this by using the [Window.FindByTitle](WindowFindByTitle.md) or [Window.FindByIndex](WindowFindByIndex.md) functions. Pass zero to access the frontmost window. | 0 |
| Alpha | The alpha value to use. Range 0.0 (invisible) to 1.0 (full visible). Default 0.5. | 0.5 |
| Red | The red color value. Default 0.0. | 0.0 |
| Green | The green color value. Default 0.0. | 0.0 |
| Blue | The blue color value. Default 0.0. | 0.0 |

### Result

Returns "OK" on success.

### Description

Adds an overlay to the window to dark content.  
This way you can have the user focus on a dialog in front of the main window.  
  
Does not work in FileMaker 18.  
Deprecated.  
### Examples

Show an overlay:

 MBS ( "Window.ShowOverlay"; Get(WindowName); 0.5 ; 0.0 ; 0.0 ; 0.0 )  
### See also

- [Window.FindByIndex](WindowFindByIndex.md)
- [Window.FindByTitle](WindowFindByTitle.md)
- [Window.HideOverlay](WindowHideOverlay.md)
- [Window.Show](WindowShow.md)

### Release notes

- **Version 10.1**
    - Deprecated [Window.AddBottomOverlay](https://www.mbsplugins.eu/WindowAddBottomOverlay.shtml), [Window.ShowContent](https://www.mbsplugins.eu/WindowShowContent.shtml), [Window.HideContent](https://www.mbsplugins.eu/WindowHideContent.shtml), [Window.ShowOverlay](https://www.mbsplugins.eu/WindowShowOverlay.shtml) and [Window.HideOverlay](https://www.mbsplugins.eu/WindowHideOverlay.shtml). If you need those, let us know soon.

### Blog Entries

- [MBS FileMaker Plugin, version 10.1pr7](https://www.mbsplugins.de/archive/2020-03-05/MBS_FileMaker_Plugin_version_1/monkeybreadsoftware_blog_filemaker)
- [MBS Filemaker Plugin, version 4.0pr1](https://www.mbsplugins.de/archive/2014-01-03/MBS_Filemaker_Plugin_version_4/monkeybreadsoftware_blog_filemaker)
- [MBS Filemaker Plugin, version 2.3pr2](https://www.mbsplugins.de/archive/2011-03-28/MBS_Filemaker_Plugin_version_2/monkeybreadsoftware_blog_filemaker)
- [MBS Filemaker Plugin, version 2.3pr4](https://www.mbsplugins.de/archive/2011-02-18/MBS_Filemaker_Plugin_version_2/monkeybreadsoftware_blog_filemaker)

This function is free to use.

Created 18th August 2014 , last changed 12nd June 2020

  
[Window.ShowKeyboard](WindowShowKeyboard.md) - [Window.ShowScrollbars](WindowShowScrollbars.md)

[HTML Version](WindowShowOverlay.shtml)