LightDismissOverlayMode Enum

Reference

Definition

Namespace:: Windows.UI.Xaml.Controls

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

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

public enum class LightDismissOverlayMode

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
enum class LightDismissOverlayMode

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
public enum LightDismissOverlayMode

Public Enum LightDismissOverlayMode

Inheritance: Enum
LightDismissOverlayMode

Attributes: ContractVersionAttribute

Windows requirements

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

Fields

Name	Value	Description
Auto	0	The device-family the app is running on determines whether the area outside of a light-dismiss UI is darkened.
On	1	The area outside of a light-dismiss UI is darkened for all device families.
Off	2	The area outside of a light-dismiss UI is not 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

Product	Versions
WinRT	Build 14383, Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100

Share via