LightDismissOverlayMode Enum

Definition

Defines constants that specify whether the area outside of a light-dismiss UI is darkened.

Equivalent WinUI enum: LightDismissOverlayMode.

public enum class LightDismissOverlayMode
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.WebHostHidden]
enum LightDismissOverlayMode
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.WebHostHidden]
public enum LightDismissOverlayMode
Public Enum LightDismissOverlayMode
Inheritance
LightDismissOverlayMode
Attributes

Windows 10 requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Fields

Auto 0

The device-family the app is running on determines whether the area outside of a light-dismiss UI is darkened.

Off 2

The area outside of a light-dismiss UI is not darkened for all device families.

On 1

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.

Applies to