SplitView.LightDismissOverlayMode Property

Definition

Namespace:

Windows.UI.Xaml.Controls

Gets or sets a value that specifies whether the area outside of a light-dismiss UI is darkened.

public:
 property LightDismissOverlayMode LightDismissOverlayMode { LightDismissOverlayMode get(); void set(LightDismissOverlayMode value); };

LightDismissOverlayMode LightDismissOverlayMode();

void LightDismissOverlayMode(LightDismissOverlayMode value);

public LightDismissOverlayMode LightDismissOverlayMode { get; set; }

var lightDismissOverlayMode = splitView.lightDismissOverlayMode;
splitView.lightDismissOverlayMode = lightDismissOverlayMode;

Public Property LightDismissOverlayMode As LightDismissOverlayMode

Property Value

LightDismissOverlayMode

A value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is Auto.

Windows requirements

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

Remarks

Transient UI, such as open pane of a SplitView, 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.

Version compatibility

The LightDismissOverlayMode property is not available prior to Windows 10, version 1607. If your app’s 'minimum platform version' setting in Microsoft Visual Studio is less than the 'introduced version' shown in the Requirements block later in this page, you must design and test your app to account for this. For more info, see Version adaptive code.

To avoid exceptions when your app runs on previous versions of Windows 10, do not set this property in XAML or use it without performing a runtime check. This example shows how to use the ApiInformation class to check for the presence of this property before you set it.

 private void MainPage_Loaded(object sender, RoutedEventArgs e)
 {
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.SplitView", "LightDismissOverlayMode"))
    {
        splitView1.LightDismissOverlayMode = LightDismissOverlayMode.On;
    }
}