AppBar.LightDismissOverlayMode Property

Definition

Namespace:

Microsoft.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 = appBar.lightDismissOverlayMode;
appBar.lightDismissOverlayMode = lightDismissOverlayMode;

Public Property LightDismissOverlayMode As LightDismissOverlayMode

<appBar LightDismissOverlayMode="lightDismissOverlayModeMemberName" />

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.

Remarks

Transient UI, such as an open command bar, 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 not darkened. Setting LightDismissOverlayMode to On will cause other UI to be darkened when the app bar is open. This is true even if the IsSticky property is set to true to prevent light-dismiss behavior.