Window.DialogResult Propriedade

Definição

Namespace:

System.Windows

Assembly:

PresentationFramework.dll

Obtém ou define o valor do resultado da caixa de diálogo, que é o valor retornado do método 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)

Valor da propriedade

Nullable<Boolean>

Um valor Nullable<T> do tipo Boolean. O padrão é false.

Atributos

TypeConverterAttribute

Exceções

InvalidOperationException

DialogResult é definido antes de uma janela ser aberta chamando ShowDialog().

- ou -

DialogResult é definido em uma janela aberta chamando Show().

Exemplos

O exemplo a seguir mostra como configurar um botão OK e um botão Cancelar para retornar o apropriado 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

Comentários

DialogResult pode ser usado no código que mostrou uma caixa de diálogo para determinar se um usuário aceitou (true) ou cancelou (false) a caixa de diálogo. Se uma caixa de diálogo foi aceita, isso significa para o código que abriu a caixa de diálogo para recuperar os dados que foram coletados pelo usuário e processá-los. No entanto, se uma caixa de diálogo foi cancelada, isso significa que o código de chamada deve interromper qualquer processamento adicional.

Por padrão, uma caixa de diálogo é cancelada quando um usuário faz um dos seguintes procedimentos:

• PressesALT+F4.

• Clica no botão Fechar .

• Seleciona Fechar no menu Sistema.

Em todos esses casos, DialogResult é false por padrão.

Uma caixa de diálogo normalmente fornece um botão especial para cancelar uma caixa de diálogo, que é o botão cuja IsCancel propriedade está definida como true. Um botão configurado dessa forma fechará automaticamente uma janela quando ela for pressionada ou quando a tecla ESC for pressionada. Em qualquer um desses casos, DialogResult permanece false.

Uma caixa de diálogo também normalmente fornece um botão aceitar, que é o botão cuja IsDefault propriedade é definida como true. Um botão configurado dessa forma aumentará seu Click evento quando ele ou a tecla ENTER for pressionada. No entanto, ele não fechará automaticamente a caixa de diálogo nem definirá DialogResult como true. Você precisa escrever manualmente esse código, geralmente do Click manipulador de eventos para o botão padrão.

DialogResult é null quando a caixa de diálogo é mostrada, mas não é aceita nem cancelada.

Depois que uma caixa de diálogo for fechada, você poderá obter o resultado da caixa de diálogo do valor retornado pelo ShowDialog método ou inspecionando a DialogResult propriedade .

DialogResult só pode ser definido quando um Window é aberto chamando seu ShowDialog método.

Observação

Você não pode definir ou obter essa propriedade quando uma janela está hospedada em um navegador.