CancelEventArgs Clase

  • Referencia

Definición

Espacio de nombres:
System.ComponentModel
Ensamblado:
System.ComponentModel.dll
Ensamblado:
System.dll
Ensamblado:
netstandard.dll
Source:
CancelEventArgs.cs
Source:
CancelEventArgs.cs
Source:
CancelEventArgs.cs

Proporciona datos para un evento cancelable.

public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
    inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
Herencia
Object
EventArgs
CancelEventArgs
Derivado

Ejemplos

En el ejemplo siguiente se usa CancelEventArgs y un CancelEventHandler para controlar el Closing evento de .Form En este código se supone que ha creado un Form con una variable de nivel Boolean de clase denominada isDataSaved. También supone que ha agregado una instrucción para invocar el método desde el OtherInitialize método del Load formulario o el constructor (después de la llamada a 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

Comentarios

Un componente genera un evento cancelable cuando está a punto de realizar una acción que se puede cancelar, como el Closing evento de .Form

Nota

El Closing evento está en desuso y se ha reemplazado por FormClosing. Se ofrece como ejemplo aquí solo para ilustrar el uso de CancelEventArgs.

CancelEventArgs proporciona la Cancel propiedad para indicar si se debe cancelar el evento.

Constructores

CancelEventArgs()

Inicializa una nueva instancia de la clase CancelEventArgs, con la propiedad Cancel establecida en false.
CancelEventArgs(Boolean)

Inicializa una nueva instancia de la clase CancelEventArgs, estableciendo la propiedad Cancel en el valor dado.

Propiedades

Cancel

Obtiene o establece un valor que indica si se debe cancelar el evento.

Métodos

Equals(Object)

Determina si el objeto especificado es igual que el objeto actual.

(Heredado de Object)
GetHashCode()

Sirve como la función hash predeterminada.

(Heredado de Object)
GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
MemberwiseClone()

Crea una copia superficial del Object actual.

(Heredado de Object)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)

Se aplica a

Consulte también