Occurs when the application is about to shut down.
Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)
Visual Basic (Declaration)
Public Shared Event ApplicationExit As EventHandler
Dim handler As EventHandler
AddHandler Application.ApplicationExit, handler
public static event EventHandler ApplicationExit
public:
static event EventHandler^ ApplicationExit {
void add (EventHandler^ value);
void remove (EventHandler^ value);
}
/** @event */
public static void add_ApplicationExit (EventHandler value)
/** @event */
public static void remove_ApplicationExit (EventHandler value)
JScript supports the use of events, but not the declaration of new ones.
You must attach the event handlers to the Exit event to perform unhandled, required tasks before the application stops running. You can close files opened by this application, or dispose of objects that garbage collection did not reclaim.
Because this is a static event, you must detach any event handlers attached to this event in the ApplicationExit event handler itself. If you do not detach these handlers, they will remain attached to the event and continue to consume memory.
The following code example displays two forms and exits the application when both forms are closed. When the application starts and exits, the position of each form is remembered. This example demonstrates using the ApplicationExit event to know when the form positions should be persisted to the file, and when the FileStream should be closed.
The class MyApplicationContext inherits from ApplicationContext and keeps track of when each form is closed, and exits the current thread when they both are. The class remembers the position of each form when it is closed. When the ApplicationExit event occurs, the class writes the positions of each for the user to the file. The form position data is stored in a file titled appdata.txt that is created in the location determined by UserAppDataPath. The Main method calls Application.Run(context) to start the application given the ApplicationContext.
This code is an excerpt from the example shown in the ApplicationContext class overview. See ApplicationContext for the whole code listing.
Public Sub New()
MyBase.New()
formCount = 0
' Handle the ApplicationExit event to know when the application is exiting.
AddHandler Application.ApplicationExit, AddressOf OnApplicationExit
Try
' Create a file that the application will store user specific data in.
userData = New FileStream(Application.UserAppDataPath + "\appdata.txt", FileMode.OpenOrCreate)
Catch e As IOException
' Inform the user that an error occurred.
MessageBox.Show("An error occurred while attempting to show the application." + _
"The error is:" + e.ToString())
' Exit the current thread instead of showing the windows.
ExitThread()
End Try
' Create both application forms and handle the Closed event
' to know when both forms are closed.
form1 = New AppForm1()
AddHandler form1.Closed, AddressOf OnFormClosed
AddHandler form1.Closing, AddressOf OnFormClosing
formCount = formCount + 1
form2 = New AppForm2()
AddHandler form2.Closed, AddressOf OnFormClosed
AddHandler form2.Closing, AddressOf OnFormClosing
formCount = formCount + 1
' Get the form positions based upon the user specific data.
If (ReadFormDataFromFile()) Then
' If the data was read from the file, set the form
' positions manually.
form1.StartPosition = FormStartPosition.Manual
form2.StartPosition = FormStartPosition.Manual
form1.Bounds = form1Position
form2.Bounds = form2Position
End If
' Show both forms.
form1.Show()
form2.Show()
End Sub
Private Sub OnApplicationExit(ByVal sender As Object, ByVal e As EventArgs)
' When the application is exiting, write the application data to the
' user file and close it.
WriteFormDataToFile()
Try
' Ignore any errors that might occur while closing the file handle.
userData.Close()
Catch
End Try
End Sub
private MyApplicationContext() {
formCount = 0;
// Handle the ApplicationExit event to know when the application is exiting.
Application.ApplicationExit += new EventHandler(this.OnApplicationExit);
try {
// Create a file that the application will store user specific data in.
userData = new FileStream(Application.UserAppDataPath + "\\appdata.txt", FileMode.OpenOrCreate);
} catch(IOException e) {
// Inform the user that an error occurred.
MessageBox.Show("An error occurred while attempting to show the application." +
"The error is:" + e.ToString());
// Exit the current thread instead of showing the windows.
ExitThread();
}
// Create both application forms and handle the Closed event
// to know when both forms are closed.
form1 = new AppForm1();
form1.Closed += new EventHandler(OnFormClosed);
form1.Closing += new CancelEventHandler(OnFormClosing);
formCount++;
form2 = new AppForm2();
form2.Closed += new EventHandler(OnFormClosed);
form2.Closing += new CancelEventHandler(OnFormClosing);
formCount++;
// Get the form positions based upon the user specific data.
if (ReadFormDataFromFile()) {
// If the data was read from the file, set the form
// positions manually.
form1.StartPosition = FormStartPosition.Manual;
form2.StartPosition = FormStartPosition.Manual;
form1.Bounds = form1Position;
form2.Bounds = form2Position;
}
// Show both forms.
form1.Show();
form2.Show();
}
private void OnApplicationExit(object sender, EventArgs e) {
// When the application is exiting, write the application data to the
// user file and close it.
WriteFormDataToFile();
try {
// Ignore any errors that might occur while closing the file handle.
userData.Close();
} catch {}
}
MyApplicationContext()
{
formCount = 0;
// Handle the ApplicationExit event to know when the application is exiting.
Application::ApplicationExit += gcnew EventHandler( this, &MyApplicationContext::OnApplicationExit );
try
{
// Create a file that the application will store user specific data in.
userData = gcnew FileStream( String::Concat( Application::UserAppDataPath, "\\appdata.txt" ),FileMode::OpenOrCreate );
}
catch ( IOException^ e )
{
// Inform the user that an error occurred.
MessageBox::Show( "An error occurred while attempting to show the application. The error is: {0}", dynamic_cast<String^>(e) );
// Exit the current thread instead of showing the windows.
ExitThread();
}
// Create both application forms and handle the Closed event
// to know when both forms are closed.
form1 = gcnew AppForm1;
form1->Closed += gcnew EventHandler( this, &MyApplicationContext::OnFormClosed );
form1->Closing += gcnew CancelEventHandler( this, &MyApplicationContext::OnFormClosing );
formCount++;
form2 = gcnew AppForm2;
form2->Closed += gcnew EventHandler( this, &MyApplicationContext::OnFormClosed );
form2->Closing += gcnew CancelEventHandler( this, &MyApplicationContext::OnFormClosing );
formCount++;
// Get the form positions based upon the user specific data.
if ( ReadFormDataFromFile() )
{
// If the data was read from the file, set the form
// positions manually.
form1->StartPosition = FormStartPosition::Manual;
form2->StartPosition = FormStartPosition::Manual;
form1->Bounds = form1Position;
form2->Bounds = form2Position;
}
// Show both forms.
form1->Show();
form2->Show();
}
void OnApplicationExit( Object^ /*sender*/, EventArgs^ /*e*/ )
{
// When the application is exiting, write the application data to the
// user file and close it.
WriteFormDataToFile();
try
{
// Ignore any errors that might occur while closing the file handle.
userData->Close();
}
catch ( Exception^ )
{
}
}
private:
private MyApplicationContext()
{
formCount = 0;
// Handle the ApplicationExit event to know
// when the application is exiting.
Application.add_ApplicationExit(new EventHandler(
this.OnApplicationExit));
try {
// Create a file that the application will store
// user specific data in.
userData = new FileStream(Application.get_UserAppDataPath()
+ "\\appdata.txt", FileMode.OpenOrCreate);
}
catch (IOException e) {
// Inform the user that an error occurred.
MessageBox.Show("An error occurred while attempting to show the "
+ " application. The error is:" + e.ToString());
// Exit the current thread instead of showing the windows.
ExitThread();
}
// Create both application forms and handle the Closed event
// to know when both forms are closed.
form1 = new AppForm1();
form1.add_Closed(new EventHandler(OnFormClosed));
form1.add_Closing(new CancelEventHandler(OnFormClosing));
formCount++;
form2 = new AppForm2();
form2.add_Closed(new EventHandler(OnFormClosed));
form2.add_Closing(new CancelEventHandler(OnFormClosing));
formCount++;
// Get the form positions based upon the user specific data.
if (ReadFormDataFromFile()) {
// If the data was read from the file, set the form
// positions manually.
form1.set_StartPosition(FormStartPosition.Manual);
form2.set_StartPosition(FormStartPosition.Manual);
form1.set_Bounds(form1Position);
form2.set_Bounds(form2Position);
}
// Show both forms.
form1.Show();
form2.Show();
} //MyApplicationContext
private void OnApplicationExit(Object sender, EventArgs e)
{
// When the application is exiting, write the application data to the
// user file and close it.
WriteFormDataToFile();
try {
// Ignore any errors that might occur while closing the file handle.
userData.Close();
}
catch (System.Exception exp) {
}
} //OnApplicationExit
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.
.NET Framework
Supported in: 2.0, 1.1, 1.0