CancelEventArgs Classe

  • Referência

Definição

Namespace:
System.ComponentModel
Assembly:
System.ComponentModel.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Origem:
CancelEventArgs.cs
Origem:
CancelEventArgs.cs
Origem:
CancelEventArgs.cs

Fornece dados para um evento cancelável.

public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
    inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
Herança
Object
EventArgs
CancelEventArgs
Derivado

Exemplos

O exemplo a seguir usa CancelEventArgs e um CancelEventHandler para manipular o Closing evento de um Form. Esse código pressupõe que você tenha criado um Form com uma variável de nível Boolean de classe chamada isDataSaved. Ele também pressupõe que você tenha adicionado uma instrução para invocar o OtherInitialize método do método do Load formulário ou do construtor (após a chamada para 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

Comentários

Um evento cancelável é gerado por um componente quando ele está prestes a executar uma ação que pode ser cancelada, como o Closing evento de um Form.

Observação

O Closing evento foi preterido e foi substituído por FormClosing. Ele é oferecido como um exemplo aqui apenas para ilustrar o uso de CancelEventArgs.

CancelEventArgs fornece a Cancel propriedade para indicar se o evento deve ser cancelado.

Construtores

CancelEventArgs()

Inicializa uma nova instância da classe CancelEventArgs com a propriedade Cancel definida como false.
CancelEventArgs(Boolean)

Inicializa uma nova instância da classe CancelEventArgs com a propriedade Cancel definida como o valor especificado.

Propriedades

Cancel

Obtém ou define um valor que indica se o evento deve ser cancelado.

Métodos

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.

(Herdado de Object)

Aplica-se a

Confira também