Window.DialogResult Właściwość

Definicja

Przestrzeń nazw:

System.Windows

Zestaw:

PresentationFramework.dll

Pobiera lub ustawia wartość wyniku okna dialogowego, czyli wartość zwracaną z metody ShowDialog().

public:
 property Nullable<bool> DialogResult { Nullable<bool> get(); void set(Nullable<bool> value); };

[System.ComponentModel.TypeConverter(typeof(System.Windows.DialogResultConverter))]
public bool? DialogResult { get; set; }

[<System.ComponentModel.TypeConverter(typeof(System.Windows.DialogResultConverter))>]
member this.DialogResult : Nullable<bool> with get, set

Public Property DialogResult As Nullable(Of Boolean)

Wartość właściwości

Nullable<Boolean>

Wartość Nullable<T> typu Boolean. Wartość domyślna to false.

Atrybuty

TypeConverterAttribute

Wyjątki

InvalidOperationException

DialogResult jest ustawiana przed otwarciem okna przez wywołanie ShowDialog().

-lub-

DialogResult jest ustawiana w oknie otwartym przez wywołanie Show().

Przykłady

W poniższym przykładzie pokazano, jak skonfigurować przycisk OK i przycisk Anuluj, aby zwrócić odpowiednie DialogResult.

<Button IsDefault="True" Click="acceptButton_Click">OK (IsDefault=True)</Button>
<Button IsCancel="True">Cancel (IsCancel=True)</Button>

using System;
using System.Windows;
using System.Windows.Controls;

namespace CSharp
{
    public partial class DialogBox : Window
    {
        public DialogBox()
        {
            InitializeComponent();
        }

        // The accept button is a button whose IsDefault property is set to true.
        // This event is raised whenever this button is clicked, or the ENTER key
        // is pressed.
        void acceptButton_Click(object sender, RoutedEventArgs e)
        {
            // Accept the dialog and return the dialog result
            this.DialogResult = true;
        }
    }
}

Imports System.Windows
Imports System.Windows.Controls

Namespace VisualBasic
    Partial Public Class DialogBox
        Inherits Window
        Public Sub New()
            InitializeComponent()
        End Sub

        ' The accept button is a button whose IsDefault property is set to true.
        ' This event is raised whenever this button is clicked, or the ENTER key
        ' is pressed.
        Private Sub acceptButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
            ' Accept the dialog and return the dialog result
            Me.DialogResult = True
        End Sub
    End Class
End Namespace

Uwagi

DialogResult można użyć z kodu, który pokazał okno dialogowe, aby określić, czy użytkownik zaakceptował (true) lub anulował (false) okno dialogowe. Jeśli okno dialogowe zostało zaakceptowane, oznacza to kod, który otworzył okno dialogowe w celu pobrania danych zebranych przez użytkownika i przetworzenia go. Jeśli jednak anulowano okno dialogowe, oznacza to, że wywołanie kodu powinno zatrzymać dalsze przetwarzanie.

Domyślnie okno dialogowe jest anulowane, gdy użytkownik wykonuje jedną z następujących czynności:

• Naciska ALT+F4.

• Klika przycisk Zamknij.

• Wybiera Zamknij z menu System.

We wszystkich tych przypadkach DialogResult jest domyślnie false.

Okno dialogowe zazwyczaj udostępnia specjalny przycisk do anulowania okna dialogowego, który jest przyciskiem, którego właściwość IsCancel jest ustawiona na true. Przycisk skonfigurowany w ten sposób automatycznie zamyka okno po naciśnięciu ESC lub naciśnięciu ESC. W jednym z tych przypadków DialogResult pozostaje false.

Okno dialogowe zazwyczaj udostępnia również przycisk akceptowania, który jest przyciskiem, którego właściwość IsDefault jest ustawiona na true. Przycisk skonfigurowany w ten sposób spowoduje podniesienie Click zdarzenia po naciśnięciu ENTER lub ENTER. Nie spowoduje to jednak automatycznego zamknięcia okna dialogowego ani ustawienia DialogResult na wartość true. Należy ręcznie napisać ten kod, zazwyczaj z programu obsługi zdarzeń Click dla przycisku domyślnego.

DialogResult jest null, gdy zostanie wyświetlone okno dialogowe, ale ani nie zostanie zaakceptowane, ani anulowane.

Po zamknięciu okna dialogowego można uzyskać wynik okna dialogowego z wartości zwróconej przez metodę ShowDialog lub sprawdzając właściwość DialogResult.

DialogResult można ustawić tylko po otwarciu Window przez wywołanie metody ShowDialog.

Nuta

Nie można ustawić ani pobrać tej właściwości, gdy okno jest hostowane w przeglądarce.