CancelEventArgs Klasse

Definition

Stellt Daten für ein abbrechbares Ereignis bereit.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
Vererbung
CancelEventArgs
Abgeleitet

Beispiele

Im folgenden Beispiel wird CancelEventArgs und ein CancelEventHandler verwendet, um Closing das-Ereignis Formvon zu behandeln.The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. Bei diesem Code wird davon ausgegangen, dass Form Sie eine mit einer Variablen Boolean auf Klassen isDataSavedEbene mit dem Namen erstellt haben.This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. Außerdem wird davon ausgegangen, dass Sie eine-Anweisung hinzugefügt OtherInitialize haben, um die- Load Methode aus der-Methode des Formulars oder dem- InitializeComponentKonstruktor (nach dem Aufruf von) aufzurufen.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

Hinweise

Ein Ereignis, das abgebrochen werden kann, wird von einer Komponente ausgelöst, wenn es darum geht, eine Aktion auszuführen, die Closing abgebrochen werden Formkann, z. b. das-Ereignis von.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.

Hinweis

Das Closing Ereignis ist veraltet und wurde durch FormClosingersetzt.The Closing event is deprecated and has been replaced by FormClosing. Sie wird hier als Beispiel angeboten, um die Verwendung von CancelEventArgszu veranschaulichen.It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgsstellt die Cancel -Eigenschaft bereit, um anzugeben, ob das Ereignis abgebrochen werden soll.CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

Konstruktoren

CancelEventArgs()

Initialisiert eine neue Instanz der CancelEventArgs-Klasse, wobei die Cancel-Eigenschaft auf false festgelegt ist.Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

CancelEventArgs(Boolean)

Initialisiert eine neue Instanz der CancelEventArgs-Klasse, wobei die Cancel-Eigenschaft auf den angegebenen Wert festgelegt ist.Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

Eigenschaften

Cancel

Ruft einen Wert ab, der angibt, ob das Ereignis abgebrochen werden soll, oder legt diesen fest.Gets or sets a value indicating whether the event should be canceled.

Methoden

Equals(Object)

Bestimmt, ob das angegebene Objekt mit dem aktuellen Objekt identisch ist.Determines whether the specified object is equal to the current object.

(Geerbt von Object)
GetHashCode()

Fungiert als Standardhashfunktion.Serves as the default hash function.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Geerbt von Object)
MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Geerbt von Object)
ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Geerbt von Object)

Gilt für:

Siehe auch