CancelEventArgs Třída

Definice

Poskytuje data pro událost, kterou lze zrušit.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
Dědičnost
CancelEventArgs
Odvozené

Příklady

Následující příklad používá CancelEventArgs a CancelEventHandler ke zpracování Closing události Form .The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. Tento kód předpokládá, že jste vytvořili objekt Form s proměnnou na úrovni třídy Boolean s názvem isDataSaved .This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. Také předpokládá, že jste přidali příkaz pro vyvolání OtherInitialize metody z Load metody formuláře nebo konstruktoru (po volání 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

Poznámky

Událost, kterou lze zrušit, je vyvolána komponentou, když se chystá provést akci, která může být zrušena, jako je například Closing událost 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.

Poznámka

ClosingUdálost je zastaralá a nahradila ji FormClosing .The Closing event is deprecated and has been replaced by FormClosing. Tato nabídka je k dispozici jako příklad pouze k ilustraci použití CancelEventArgs .It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgs poskytuje Cancel vlastnost určující, zda má být událost zrušena.CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

Konstruktory

CancelEventArgs()

Inicializuje novou instanci CancelEventArgs třídy s Cancel vlastností nastavenou na false .Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

CancelEventArgs(Boolean)

Inicializuje novou instanci CancelEventArgs třídy s Cancel vlastností nastavenou na danou hodnotu.Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

Vlastnosti

Cancel

Získá nebo nastaví hodnotu označující, jestli se má událost zrušit.Gets or sets a value indicating whether the event should be canceled.

Metody

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.Determines whether the specified object is equal to the current object.

(Zděděno od Object)
GetHashCode()

Slouží jako výchozí funkce hash.Serves as the default hash function.

(Zděděno od Object)
GetType()

Získá Type aktuální instanci.Gets the Type of the current instance.

(Zděděno od Object)
MemberwiseClone()

Vytvoří kopii aktuálního seznamu Object .Creates a shallow copy of the current Object.

(Zděděno od Object)
ToString()

Vrátí řetězec, který představuje aktuální objekt.Returns a string that represents the current object.

(Zděděno od Object)

Platí pro

Viz také