Window.DialogResult Propriété

Définition

Espace de noms:

System.Windows

Assembly:

PresentationFramework.dll

Obtient ou définit la valeur de résultat de la boîte de dialogue, qui est la valeur retournée par la méthode 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)

Valeur de propriété

Nullable<Boolean>

Valeur Nullable<T> de type Boolean. La valeur par défaut est false.

Attributs

TypeConverterAttribute

Exceptions

InvalidOperationException

DialogResult est défini avant l’ouverture d’une fenêtre en appelant ShowDialog().

-ou-

DialogResult est défini sur une fenêtre ouverte en appelant Show().

Exemples

L’exemple suivant montre comment configurer un bouton OK et un bouton Annuler pour renvoyer la DialogResultappropriée.

<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

Remarques

DialogResult pouvez être utilisé à partir du code qui a montré une boîte de dialogue pour déterminer si un utilisateur a accepté (true) ou annulé (false) la boîte de dialogue. Si une boîte de dialogue a été acceptée, cela signifie le code qui a ouvert la boîte de dialogue pour récupérer les données collectées par l’utilisateur et les traiter. Toutefois, si une boîte de dialogue a été annulée, cela signifie que l’appel du code doit arrêter tout traitement supplémentaire.

Par défaut, une boîte de dialogue est annulée lorsqu’un utilisateur effectue l’une des opérations suivantes :

• Appuie sur Alt+F4.

• Cliquez sur le bouton Fermer.

• Sélectionne Fermer dans le menu Système.

Dans tous ces cas, DialogResult est false par défaut.

Une boîte de dialogue fournit généralement un bouton spécial pour annuler une boîte de dialogue, qui est le bouton dont la propriété IsCancel est définie sur true. Un bouton configuré de cette façon ferme automatiquement une fenêtre lorsqu’elle est enfoncée ou lorsque la touche Échap est enfoncée. Dans l’un de ces cas, DialogResult reste false.

Une boîte de dialogue fournit généralement un bouton d’acceptation, qui est le bouton dont la propriété IsDefault est définie sur true. Un bouton configuré de cette façon déclenche son événement de Click lorsque la touche Entrée est enfoncée. Toutefois, il ne ferme pas automatiquement la boîte de dialogue, ni ne définit DialogResult sur true. Vous devez écrire manuellement ce code, généralement à partir du gestionnaire d’événements Click pour le bouton par défaut.

DialogResult est null lorsque la boîte de dialogue est affichée, mais ni acceptée ni annulée.

Une fois qu’une boîte de dialogue se ferme, vous pouvez obtenir le résultat de la boîte de dialogue à partir de la valeur retournée par ShowDialog méthode, ou en inspectant la propriété DialogResult.

DialogResult ne peut être défini que lorsqu’un Window est ouvert en appelant sa méthode ShowDialog.

Note

Vous ne pouvez pas définir ou obtenir cette propriété lorsqu’une fenêtre est hébergée dans un navigateur.