Popup.LightDismissOverlayMode Property
Definition
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 = popup.lightDismissOverlayMode;
popup.lightDismissOverlayMode = lightDismissOverlayMode;Public Property LightDismissOverlayMode As LightDismissOverlayModeProperty Value
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 a Popup, 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.