FormClosingEventArgs.CloseReason Propriedade

Definição

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Obtém um valor que indica por que o formulário está sendo fechado.

public:
 property System::Windows::Forms::CloseReason CloseReason { System::Windows::Forms::CloseReason get(); };

public System.Windows.Forms.CloseReason CloseReason { get; }

member this.CloseReason : System.Windows.Forms.CloseReason

Public ReadOnly Property CloseReason As CloseReason

Valor da propriedade

CloseReason

Um dos valores enumerados CloseReason.

Exemplos

O exemplo de código a seguir demonstra o uso desse membro. No exemplo, um manipulador de eventos relata a ocorrência do Form.FormClosing evento. Este relatório ajuda você a aprender quando o evento ocorre e pode ajudá-lo na depuração. Para relatar vários eventos ou eventos que ocorrem com frequência, considere substituir MessageBox.ShowConsole.WriteLine ou acrescentar a mensagem a uma multilinha TextBox.

Para executar o código de exemplo, cole-o em um projeto que contém uma instância do tipo Form chamada Form1. Em seguida, verifique se o manipulador de eventos está associado ao Form.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

Comentários

Um Form pode ser fechado devido a uma variedade de motivos, iniciados pelo usuário e programáticos. A CloseReason propriedade indica um motivo para o fechamento.

Confira também

• Form
• CloseReason