CancelEventArgs Klasa

Definicja

Zawiera dane dla zdarzenia, które ma być anulowane.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
Dziedziczenie
CancelEventArgs
Pochodne

Przykłady

Poniższy przykład używa CancelEventArgs i a CancelEventHandler do obsługi Closing zdarzenia Form .The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. W tym kodzie założono, że utworzono obiekt Form z zmienną na poziomie klasy Boolean o nazwie isDataSaved .This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. Zakłada również, że dodano instrukcję do wywołania OtherInitialize metody z Load metody formularza lub konstruktora (po wywołaniu do 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

Uwagi

Zdarzenie możliwe do anulowania jest zgłaszane przez składnik, gdy ma on wykonać akcję, która może zostać anulowana, na przykład Closing zdarzenie Form .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.

Uwaga

ClosingZdarzenie jest przestarzałe i zastąpione przez FormClosing .The Closing event is deprecated and has been replaced by FormClosing. Jest on oferowany jako przykład tylko w celu zilustrowania użycia CancelEventArgs .It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgs udostępnia Cancel Właściwość wskazującą, czy zdarzenie powinno być anulowane.CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

Konstruktory

CancelEventArgs()

Inicjuje nowe wystąpienie CancelEventArgs klasy z Cancel właściwością ustawioną na false .Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

CancelEventArgs(Boolean)

Inicjuje nowe wystąpienie CancelEventArgs klasy z Cancel właściwością ustawioną na daną wartość.Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

Właściwości

Cancel

Pobiera lub ustawia wartość wskazującą, czy zdarzenie powinno być anulowane.Gets or sets a value indicating whether the event should be canceled.

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Dotyczy

Zobacz też