CancelEventArgs Klass

Definition

Namnområde:
System.ComponentModel
Sammansättningar:
System.dll, System.ComponentModel.dll
Sammansättning:
System.dll
Sammansättning:
netstandard.dll

Tillhandahåller data för en avbruten händelse.

public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
    inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
Arv
Object
EventArgs
CancelEventArgs
Härledda

Exempel

I följande exempel används CancelEventArgs och a CancelEventHandler för att hantera Closing händelsen för en Form. Den här koden förutsätter att du har skapat en Form med en variabel på klassnivå Boolean med namnet isDataSaved. Det förutsätter också att du har lagt till en -instruktion för att anropa OtherInitialize metoden från formulärets Load metod eller konstruktorn (efter anropet till 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
void OtherInitialize()
{
    Closing += Form1_Closing;
    // Exchange commented line and note the difference.
    isDataSaved = true;
    //this.isDataSaved = false;
}

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

Kommentarer

En avbruten händelse genereras av en komponent när den är på väg att utföra en åtgärd som kan avbrytas, till exempel Closing händelsen för en Form.

Note

Händelsen Closing är inaktuell och har ersatts av FormClosing. Det erbjuds som ett exempel här bara för att illustrera användningen av CancelEventArgs.

CancelEventArgs tillhandahåller egenskapen Cancel för att ange om händelsen ska avbrytas.

Konstruktorer

Name Description
CancelEventArgs()

Initierar en ny instans av CancelEventArgs klassen med egenskapen inställd på Cancelfalse.
CancelEventArgs(Boolean)

Initierar en ny instans av CancelEventArgs klassen med Cancel egenskapen inställd på det angivna värdet.

Egenskaper

Name Description
Cancel

Hämtar eller anger ett värde som anger om händelsen ska avbrytas.

Metoder

Name Description
Equals(Object)

Avgör om det angivna objektet är lika med det aktuella objektet.

(Ärvd från Object)
GetHashCode()

Fungerar som standard-hash-funktion.

(Ärvd från Object)
GetType()

Hämtar den aktuella instansen Type .

(Ärvd från Object)
MemberwiseClone()

Skapar en ytlig kopia av den aktuella Object.

(Ärvd från Object)
ToString()

Returnerar en sträng som representerar det aktuella objektet.

(Ärvd från Object)

Gäller för

Se även