Window.DialogResult Свойство

Определение

Пространство имен:

System.Windows

Сборка:

PresentationFramework.dll

Возвращает или задает значение результата диалога, которое является значением, возвращаемым из метода 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)

Значение свойства

Nullable<Boolean>

Значение Nullable<T> типа Boolean. Значение по умолчанию — false.

Атрибуты

TypeConverterAttribute

Исключения

InvalidOperationException

DialogResult устанавливается перед открытием окна путем вызова ShowDialog().

-или-

DialogResult устанавливается в окне, которое открывается путем вызова Show().

Примеры

В следующем примере показано, как настроить кнопку "ОК" и кнопку "Отмена", чтобы вернуть соответствующие 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

Комментарии

DialogResult можно использовать из кода, отображающего диалоговое окно, чтобы определить, принят ли пользователь (true) или отменен (false) диалоговое окно. Если диалоговое окно принято, это означает код, открывший диалоговое окно, чтобы получить данные, собранные пользователем, и обработать его. Если диалоговое окно было отменено, это означает, что вызывающий код должен остановить любую дальнейшую обработку.

По умолчанию диалоговое окно отменяется, когда пользователь выполняет одно из следующих действий:

• Нажимает КЛАВИШИ ALT+F4.

• Нажмите кнопку Закрыть.

• В меню "Система" выберите Закрыть.

Во всех этих случаях DialogResult по умолчанию false.

Диалоговое окно обычно предоставляет специальную кнопку для отмены диалогового окна, которая является кнопкой, IsCancel свойству которой задано значение true. Кнопка, настроенная таким образом, автоматически закрывает окно при нажатии или нажатии клавиши ESC. В любом из этих случаев DialogResult остается false.

Диалоговое окно также обычно предоставляет кнопку "Принять", которая является кнопкой, свойство IsDefault которой имеет значение true. Кнопка, настроенная таким образом, вызовет событие Click при нажатии клавиши ВВОД. Однако он не будет автоматически закрывать диалоговое окно и не будет устанавливать DialogResult для true. Этот код необходимо писать вручную, как правило, из обработчика событий Click для кнопки по умолчанию.

DialogResult null, если диалоговое окно отображается, но не принимается и не отменено.

После закрытия диалогового окна можно получить результат диалога из значения, возвращаемого методом ShowDialog, или проверить свойство DialogResult.

DialogResult можно задать только при открытии Window путем вызова метода ShowDialog.

Заметка

Невозможно задать или получить это свойство, если окно размещено в браузере.