CancelEventArgs CancelEventArgs CancelEventArgs CancelEventArgs Class

Définition

Fournit des données pour un événement annulable.Provides data for a cancelable event.

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

Exemples

L’exemple suivant utilise CancelEventArgs et un CancelEventHandler pour gérer l' Closing événement d’un Form.The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. Ce code suppose que vous avez créé un Form avec une variable au niveau Boolean de la classe isDataSavednommée.This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. Elle suppose également que vous avez ajouté une instruction pour appeler la OtherInitialize méthode à partir de la méthode du Load formulaire ou du constructeur (après l’appel InitializeComponentà).It also assumes that you have added a statement to invoke the OtherInitialize method from the form's Load method or the constructor (after the call to 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 Closing que l’événement Formd’un.A cancelable event is raised by a component when it is about to perform an action that can be canceled, such as the Closing event of a Form.

Notes

L' Closing événement est déconseillé et a été remplacé par FormClosing.The Closing event is deprecated and has been replaced by FormClosing. Elle est proposée comme exemple ici uniquement pour illustrer l’utilisation de CancelEventArgs.It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgsfournit la Cancel propriété pour indiquer si l’événement doit être annulé.CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

Constructeurs

CancelEventArgs() CancelEventArgs() CancelEventArgs() CancelEventArgs()

Initialise une nouvelle instance de la classe CancelEventArgs avec la propriété Cancel définie avec la valeur false.Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

CancelEventArgs(Boolean) CancelEventArgs(Boolean) CancelEventArgs(Boolean) CancelEventArgs(Boolean)

Initialise une nouvelle instance de la classe CancelEventArgs avec la propriété Cancel définie avec la valeur indiquée.Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

Propriétés

Cancel Cancel Cancel Cancel

Obtient ou définit une valeur indiquant si l'événement doit être annulé.Gets or sets a value indicating whether the event should be canceled.

Méthodes

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Détermine si l'objet spécifié est identique à l'objet actuel.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Fait office de fonction de hachage par défaut.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Inherited from Object)

S’applique à

Voir aussi