FormClosingEventArgs Classe

Definição

public ref class FormClosingEventArgs : System::ComponentModel::CancelEventArgs

public class FormClosingEventArgs : System.ComponentModel.CancelEventArgs

type FormClosingEventArgs = class
    inherit CancelEventArgs

Public Class FormClosingEventArgs
Inherits CancelEventArgs

Herança

Object

EventArgs

CancelEventArgs

FormClosingEventArgs

Exemplos

O seguinte exemplo de código demonstra o uso deste tipo. No exemplo, um gestor de eventos reporta a ocorrência do FormClosing evento. Este relatório ajuda-o a saber quando o evento ocorre e pode ajudá-lo na depuração. Para reportar múltiplos eventos ou eventos que ocorrem frequentemente, considere substituir Show ou Console.WriteLine anexar a mensagem a uma multilinha TextBox.

Para executar o código de exemplo, cole-o num projeto que contenha uma instância do tipo Form chamada Form1. Depois, certifique-se de que o gestor de eventos está associado ao FormClosing evento.

private void Form1_FormClosing(Object sender, FormClosingEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "CloseReason", e.CloseReason );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "FormClosing Event" );
}

Private Sub Form1_FormClosing(sender as Object, e as FormClosingEventArgs) _ 
     Handles Form1.FormClosing

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "CloseReason", e.CloseReason)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"FormClosing Event")

End Sub

Observações

O FormClosing evento ocorre pouco antes de um formulário ser fechado, seja pelo utilizador, através da interface do utilizador (UI), ou programaticamente, através de chamadas a métodos como Close na Form classe ou Exit na Application classe.

Se um formulário tiver formulários filhos ou propriedades, também é criado um FormClosing evento para cada um. Se algum dos formulários cancelar o evento, nenhum dos formulários é fechado. Portanto, os eventos correspondentes FormClosed não são enviados para nenhuma das formas.

A FormClosingEventArgs turma fornece dados para este evento. Dois membros importantes são os Cancel e CloseReason as propriedades. O evento pode ser cancelado definindo a Cancel propriedade como verdadeira. A CloseReason propriedade fornece uma razão para o encerramento do formulário.

Ver também

• Form
• FormClosing
• Close()
• Exit()
• CloseReason
• FormClosingEventHandler
• FormClosedEventArgs