Window.DialogResult Propiedad

Definición

Espacio de nombres:

System.Windows

Ensamblado:

PresentationFramework.dll

Obtiene o establece el valor de resultado del cuadro de diálogo, que es el valor que se devuelve del 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 de propiedad

Nullable<Boolean>

Valor Nullable<T> de tipo Boolean. El valor predeterminado es false.

Atributos

TypeConverterAttribute

Excepciones

InvalidOperationException

DialogResult se establece antes de que se abra una ventana llamando a ShowDialog().

-o-

DialogResult se establece en una ventana que se abre llamando a Show().

Ejemplos

En el ejemplo siguiente se muestra cómo configurar un botón Aceptar y un botón Cancelar para devolver el DialogResultadecuado.

<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

Comentarios

DialogResult se puede usar desde el código que mostró un cuadro de diálogo para determinar si un usuario aceptó (true) o canceló (false) el cuadro de diálogo. Si se aceptó un cuadro de diálogo, esto significa que el código que abrió el cuadro de diálogo para recuperar los datos recopilados por el usuario y procesarlos. Sin embargo, si se canceló un cuadro de diálogo, esto significa que la llamada al código debe detener cualquier procesamiento adicional.

De forma predeterminada, se cancela un cuadro de diálogo cuando un usuario realiza una de las siguientes acciones:

• Presiona ALT+F4.

• Hace clic en el botón Cerrar .

• Selecciona Cerrar en el menú Sistema.

En todos estos casos, DialogResult se false de forma predeterminada.

Normalmente, un cuadro de diálogo proporciona un botón especial para cancelar un diálogo, que es el botón cuya propiedad IsCancel está establecida en true. Un botón configurado de esta manera cerrará automáticamente una ventana cuando se presione o cuando se presione la tecla ESC. En cualquiera de estos casos, DialogResult permanece false.

Un cuadro de diálogo también suele proporcionar un botón aceptar, que es el botón cuya propiedad IsDefault está establecida en true. Un botón configurado de esta manera generará su evento de Click cuando se presione o la tecla ENTRAR. Sin embargo, no cerrará automáticamente el cuadro de diálogo ni establecerá DialogResult en true. Debe escribir manualmente este código, normalmente desde el controlador de eventos Click para el botón predeterminado.

DialogResult se null cuando se muestra el cuadro de diálogo, pero no se acepta ni se cancela.

Una vez que se cierra un cuadro de diálogo, puede obtener el resultado del cuadro de diálogo del valor devuelto por ShowDialog método o inspeccionando la propiedad DialogResult.

DialogResult solo se puede establecer cuando se abre un Window llamando a su método ShowDialog.

Nota

No se puede establecer ni obtener esta propiedad cuando se hospeda una ventana en un explorador.