CancelEventArgs Classe

Definição

{1>Fornece dados para um evento cancelável.<1}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
Herança
CancelEventArgs
Derivado

Exemplos

O exemplo a seguir usa CancelEventArgs e uma CancelEventHandler para manipular o evento Closing de um Form.The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. Esse código pressupõe que você criou um Form com uma variável Boolean no nível de classe denominada isDataSaved.This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. Ele também pressupõe que você tenha adicionado uma instrução para invocar o método OtherInitialize do método Load do formulário ou o Construtor (após a chamada para 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

Comentários

Um evento cancelável é gerado por um componente quando está prestes a executar uma ação que pode ser cancelada, como o Closing evento de um 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.

Observação

O evento Closing foi preterido e foi substituído por FormClosing.The Closing event is deprecated and has been replaced by FormClosing. Ele é oferecido como um exemplo aqui apenas para ilustrar o uso de CancelEventArgs.It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgs fornece a propriedade Cancel para indicar se o evento deve ser cancelado.CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

Construtores

CancelEventArgs()

Inicializa uma nova instância da classe CancelEventArgs com a propriedade Cancel definida como false.Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

CancelEventArgs(Boolean)

Inicializa uma nova instância da classe CancelEventArgs com a propriedade Cancel definida como o valor especificado.Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

Propriedades

Cancel

Obtém ou define um valor que indica se o evento deve ser cancelado.Gets or sets a value indicating whether the event should be canceled.

Métodos

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Aplica-se a

Veja também