ContentDialog.DefaultButton プロパティ

定義

ダイアログの既定のアクションであるボタンを示す値を取得または設定します。

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

void DefaultButton(ContentDialogButton value);
public ContentDialogButton DefaultButton { get; set; }
var contentDialogButton = contentDialog.defaultButton;
contentDialog.defaultButton = contentDialogButton;
Public Property DefaultButton As ContentDialogButton

プロパティ値

列挙体の値。 既定値は None です。

Windows の要件

デバイス ファミリ
Windows 10 Creators Update (10.0.15063.0 で導入)
API contract
Windows.Foundation.UniversalApiContract (v4.0 で導入)

注釈

必要に応じて、3 つのボタンのうちの 1 つを既定のボタンとして区別できます。 既定のボタンを指定すると、次のようになります。

  • ボタンにアクセント ボタンとして視覚的な効果が適用される
  • ボタンが Enter キーに自動的に応答する
    • ユーザーがキーボードの Enter キーを押すと、既定のボタンに関連付けられているクリック ハンドラーが起動し、 ContentDialogResult は既定のボタンに関連付けられている値を返します
    • ユーザーが Enter キーを処理するコントロールにフォーカスを置いた場合、既定のボタンは Enter キーを押しても応答しません
  • ダイアログのコンテンツにフォーカス可能な UI が含まれている場合を除き、ダイアログが開くと、ボタンは自動的にフォーカスを受け取ります

バージョンの互換性

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

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

<ContentDialog x:Name="contentDialog1" Loaded="ContentDialog_Loaded">
    ...
</ContentDialog>
private void ContentDialog_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.ContentDialog", "DefaultButton"))
    {
        contentDialog1.DefaultButton = ContentDialogButton.Primary;
    }
}

適用対象