CancelEventArgs Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
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
- Derivado
Exemplos
O exemplo seguinte usa CancelEventArgs e a CancelEventHandler para tratar o Closing evento de um Form. Este código assume que criou um Form com uma variável ao nível Boolean da classe chamada isDataSaved. Também assume que adicionou uma instrução para invocar o OtherInitialize método a partir 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
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
Observações
Um evento cancelável é levantado por um componente quando este está prestes a realizar uma ação que pode ser cancelada, como o Closing evento de um Form.
Observação
O Closing evento está obsoleto e foi substituído por FormClosing. É apresentado como exemplo aqui apenas para ilustrar o uso de CancelEventArgs.
CancelEventArgs fornece a Cancel propriedade para indicar se o evento deve ser cancelado.
Construtores
| Name | Description |
|---|---|
| CancelEventArgs() |
Inicializa uma nova instância da CancelEventArgs classe com a Cancel propriedade definida em |
| CancelEventArgs(Boolean) |
Inicializa uma nova instância da CancelEventArgs classe com a Cancel propriedade definida para o valor dado. |
Propriedades
| Name | Description |
|---|---|
| Cancel |
Recebe ou define um valor que indica se o evento deve ser cancelado. |
Métodos
| Name | Description |
|---|---|
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetHashCode() |
Serve como função de hash predefinida. (Herdado de Object) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |