LightDismissOverlayMode
LightDismissOverlayMode
LightDismissOverlayMode
LightDismissOverlayMode
Enum
Definition
Defines constants that specify whether the area outside of a light-dismiss UI is darkened.
public : enum class LightDismissOverlayModepublic enum LightDismissOverlayModePublic Enum LightDismissOverlayMode// This API is not available in Javascript.
- Attributes
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Fields
| Auto Auto Auto Auto | The device-family the app is running on determines whether the area outside of a light-dismiss UI is darkened. |
| Off Off Off Off | The area outside of a light-dismiss UI is not darkened for all device families. |
| On On On On | The area outside of a light-dismiss UI is darkened for all device families. |
Remarks
Transient UI, such as a Flyout or the open drop-down of a ComboBox, closes when you click or tap outside of it. This is called light-dismiss. "Overlay" refers to the area outside of a light-dismiss UI.
By default, the "overlay" is darkened on the Xbox, and not darkened on other devices families. You can set LightDismissOverlayMode to On to make your app darken the "overlay" area on all device families, or set it to Off to not darken the "overlay" area on all device families.