FlyoutBase.LightDismissOverlayMode Property
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.
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 = flyoutBase.lightDismissOverlayMode;
flyoutBase.lightDismissOverlayMode = lightDismissOverlayMode;Public Property LightDismissOverlayMode As LightDismissOverlayModeA value of the enumeration that specifies whether the area outside of a light-dismiss UI is darkened. The default is Auto.
| Device family |
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v3.0)
|
Transient UI, such as a Flyout or MenuFlyout, 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.
For more info, see Light dismiss behavior in the Flyouts article.
| 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 |