Esta documentación está archivada y no tiene mantenimiento.

FormClosingEventArgs (Clase)

Proporciona datos del evento FormClosing.

Espacio de nombres: System.Windows.Forms
Ensamblado: System.Windows.Forms (en system.windows.forms.dll)

public class FormClosingEventArgs : CancelEventArgs
public class FormClosingEventArgs extends CancelEventArgs
public class FormClosingEventArgs extends CancelEventArgs
No aplicable.

El evento FormClosing se desencadena justo antes de que se cierre un formulario, y a sea a través de un usuario, de la interfaz de usuario o mediante programación, a través de llamadas a métodos, como Close en la clase Form o como Exit en la clase Application.

Si un formulario tiene formularios secundarios o formularios con propietario, también se desencadenará un evento FormClosing en cada uno de ellos. Si uno de los formularios cancela el evento, no se cerrará ningún formulario. Por tanto, los eventos FormClosed correspondientes no se envían a ninguno de los formularios.

La clase FormClosingEventArgs proporciona datos de este evento. Dos miembros importantes son las propiedades Cancel y CloseReason. El evento puede cancelarse estableciendo la propiedad Cancel en true. La propiedad CloseReason proporciona un motivo por el que se cierra el formulario.

En el ejemplo de código siguiente se muestra el uso de este tipo. En el ejemplo, un controlador de eventos notifica que se ha provocado el evento FormClosing. Este informe es útil para saber cuándo se provoca el evento y puede servir de ayuda en la depuración. Para informar sobre varios eventos o sobre eventos que se provocan frecuentemente, considere la posibilidad de reemplazar Show por System.Console.WriteLine o de agregar el mensaje a un TextBox de varias líneas.

Para ejecutar el código de ejemplo, péguelo en un proyecto que contenga una instancia de tipoForm con la denominación Form1. A continuación, asegúrese de que el controlador de eventos esté asociado al evento FormClosing.

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" );
}

System.Object
   System.EventArgs
     System.ComponentModel.CancelEventArgs
      System.Windows.Forms.FormClosingEventArgs

Los miembros estáticos públicos (Shared en Visual Basic) de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Windows 98, Windows 2000 Service Pack 4, Windows CE, Windows Millennium, Windows Mobile para Pocket PC, Windows Mobile para Smartphone, Windows Server 2003, Windows XP Media Center, Windows XP Professional x64, Windows XP SP2, Windows XP Starter

Microsoft .NET Framework 3.0 es compatible con Windows Vista, Microsoft Windows XP SP2 y Windows Server 2003 SP1.

.NET Framework

Compatible con: 3.0, 2.0
Mostrar: