CancelEventArgs Classe

Définition

Fournit des données pour un événement annulable.

public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
    inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
Héritage
CancelEventArgs
Dérivé

Exemples

L’exemple suivant utilise CancelEventArgs et un CancelEventHandler pour gérer l' Closing événement d’un Form . Ce code suppose que vous avez créé un Form avec une variable au niveau de la classe Boolean nommée isDataSaved . Elle suppose également que vous avez ajouté une instruction pour appeler la OtherInitialize méthode à partir de la méthode du formulaire Load ou du constructeur (après l’appel à InitializeComponent ).

private:
   // Call this method from the InitializeComponent() method of your form
   void OtherInitialize()
   {
      this->Closing += gcnew CancelEventHandler( this, &Form1::Form1_Cancel );
      this->myDataIsSaved = true;
   }

   void Form1_Cancel( Object^ /*sender*/, CancelEventArgs^ e )
   {
      if ( !myDataIsSaved )
      {
         e->Cancel = true;
         MessageBox::Show( "You must save first." );
      }
      else
      {
         e->Cancel = false;
         MessageBox::Show( "Goodbye." );
      }
   }
// Call this method from the constructor of your form
    private void OtherInitialize() {
       this.Closing += new CancelEventHandler(this.Form1_Closing);
       // Exchange commented line and note the difference.
       this.isDataSaved = true;
       //this.isDataSaved = false;
    }

    private void Form1_Closing(Object sender, CancelEventArgs e) {
       if (!isDataSaved) {
          e.Cancel = true;
          MessageBox.Show("You must save first.");
       }
       else {
          e.Cancel = false;
          MessageBox.Show("Goodbye.");
       }
    }
' Call this method from the Load method of your form.
Private Sub OtherInitialize()
    ' Exchange commented line and note the difference.
    Me.isDataSaved = True
    'Me.isDataSaved = False
End Sub

Private Sub Form1_Closing(sender As Object, e As _
   System.ComponentModel.CancelEventArgs) Handles MyBase.Closing
    If Not isDataSaved Then
        e.Cancel = True
        MessageBox.Show("You must save first.")
    Else
        e.Cancel = False
        MessageBox.Show("Goodbye.")
    End If
End Sub

Remarques

Un événement annulable est déclenché par un composant quand il est sur le paragraphe d’exécuter une action qui peut être annulée, telle que l' Closing événement d’un Form .

Notes

L' Closing événement est déconseillé et a été remplacé par FormClosing . Elle est proposée comme exemple ici uniquement pour illustrer l’utilisation de CancelEventArgs .

CancelEventArgs fournit la Cancel propriété pour indiquer si l’événement doit être annulé.

Constructeurs

CancelEventArgs()

Initialise une nouvelle instance de la classe CancelEventArgs avec la propriété Cancel définie avec la valeur false.

CancelEventArgs(Boolean)

Initialise une nouvelle instance de la classe CancelEventArgs avec la propriété Cancel définie avec la valeur indiquée.

Propriétés

Cancel

Obtient ou définit une valeur indiquant si l'événement doit être annulé.

Méthodes

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.

(Hérité de Object)
GetHashCode()

Fait office de fonction de hachage par défaut.

(Hérité de Object)
GetType()

Obtient le Type de l'instance actuelle.

(Hérité de Object)
MemberwiseClone()

Crée une copie superficielle du Object actuel.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actuel.

(Hérité de Object)

S’applique à

Voir aussi