ContentDialog.CloseButtonText プロパティ

定義

名前空間:

Windows.UI.Xaml.Controls

閉じるボタンに表示するテキストを取得または設定します。

public:
 property Platform::String ^ CloseButtonText { Platform::String ^ get(); void set(Platform::String ^ value); };

winrt::hstring CloseButtonText();

void CloseButtonText(winrt::hstring value);

public string CloseButtonText { get; set; }

var string = contentDialog.closeButtonText;
contentDialog.closeButtonText = string;

Public Property CloseButtonText As String

<ContentDialog CloseButtonText="string"/>

プロパティ値

String

Platform::String

winrt::hstring

閉じるボタンに表示するテキスト。

Windows の要件

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

注釈

すべてのダイアログには、ユーザーが安心してダイアログを終了できる、安全で非破壊的なアクション ボタンが含まれる必要があります。

閉じるボタンを使用して、このボタンを作成します。 これにより、マウス、キーボード、タッチ、およびゲームパッドを含むすべての入力に対して、適切なユーザー エクスペリエンスを作成することができます。 ダイアログは、次の場合に閉じます。

• ユーザーが閉じるボタンをクリックまたはタップする
• ユーザーがシステムの戻るボタンを押す
• ユーザーがキーボードの Esc ボタンを押す
• ユーザーがゲームパッドの B を押す

閉じるボタンを呼び出すと、ContentDialogResult.None が返されます。

バージョンの互換性

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

以前のバージョンの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", "CloseButtonText"))
    {
        contentDialog1.CloseButtonText = "Cancel";
    }
    else
    {
        contentDialog1.SecondaryButtonText = "Cancel";
    }
}