AutoSuggestBox.LightDismissOverlayMode プロパティ

定義

名前空間:

Windows.UI.Xaml.Controls

ライトを閉じる UI の外側の領域を暗くするかどうかを指定する値を取得または設定します。

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

LightDismissOverlayMode LightDismissOverlayMode();

void LightDismissOverlayMode(LightDismissOverlayMode value);

public LightDismissOverlayMode LightDismissOverlayMode { get; set; }

var lightDismissOverlayMode = autoSuggestBox.lightDismissOverlayMode;
autoSuggestBox.lightDismissOverlayMode = lightDismissOverlayMode;

Public Property LightDismissOverlayMode As LightDismissOverlayMode

プロパティ値

LightDismissOverlayMode

ライト を閉じる UI の外側の領域を暗くするかどうかを指定する 列挙体の値。 既定値は Auto です。

Windows の要件

デバイス ファミリ	Windows 10 Anniversary Edition (10.0.14393.0 で導入)
API contract	Windows.Foundation.UniversalApiContract (v3.0 で導入)

注釈

AutoSuggestBox の提案ウィンドウなどの一時的な UI は、その外側をクリックまたはタップすると閉じます。 これは、"簡易非表示" と呼ばれます。 "オーバーレイ" は、ライト無視 UI の外側の領域を指します。

既定では、Xbox では "オーバーレイ" が暗くなり、他のデバイス ファミリでは暗く表示されません。 LightDismissOverlayMode を [オン] に設定すると、アプリですべてのデバイス ファミリの "オーバーレイ" 領域が暗くなり、すべてのデバイス ファミリの "オーバーレイ" 領域が暗くされないように オフ に設定できます。

バージョンの互換性

LightDismissOverlayMode プロパティは、バージョン 1607 Windows 10より前は使用できません。 Microsoft Visual Studio のアプリの "最小プラットフォーム バージョン" 設定が、このページの後半の 「要件」 ブロックに示されている "導入されたバージョン" より小さい場合は、これを考慮してアプリを設計してテストする必要があります。 詳細については、「 バージョン アダプティブ コード」を参照してください。

以前のバージョンのWindows 10でアプリを実行するときに例外を回避するには、XAML でこのプロパティを設定したり、ランタイム チェックを実行せずに使用したりしないでください。 この例では、ApiInformation クラスを使用して、このプロパティを設定する前に、このプロパティの存在をチェックする方法を示します。

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