OnUnload Method
.NET Framework Class Library
Control..::.OnUnload Method

Updated: April 2009

Raises the Unload event.

Namespace:  System.Web.UI
Assembly:  System.Web (in System.Web.dll)
Visual Basic (Declaration)
Protected Friend Overridable Sub OnUnload ( _
    e As EventArgs _
)
Visual Basic (Usage)
Dim e As EventArgs

Me.OnUnload(e)
C#
protected internal virtual void OnUnload(
    EventArgs e
)
Visual C++
protected public:
virtual void OnUnload(
    EventArgs^ e
)
JScript
protected internal function OnUnload(
    e : EventArgs
)

Parameters

e
Type: System..::.EventArgs
An EventArgs object that contains event data.

ASP.NET calls this method in order to raise the Unload event. If you are developing a custom control, you can override this method in order to provide additional processing. If you override this method, you typically call the base control's OnUnload method. If the base control's OnUnload method is not called, subscribers to the event will not be notified.

Visual Basic
   ' Create a StreamWriter to write data to a text file.
    Dim myFile As TextWriter = File.CreateText("c:\NewTextFile.txt")

   Sub Page_Load(sender As Object, e As EventArgs)
' Write status to file.
myFile.WriteLine("Page has loaded.")
   End Sub

   Sub CustomControl_OnLoad(sender As Object, e As EventArgs)
myFile.WriteLine("Custom control has loaded.")
   End Sub

   Sub CustomControl_OnUnload(sender As Object, e As EventArgs)
' Server controls final cleanup such as;
' closing files etc.goes here         
myFile.WriteLine("Custom control was unloaded.")
' Close the stream object.
myFile.Close()
   End Sub
C#
// Create a StreamWriter to write data to a text file.
TextWriter myFile = File.CreateText("c:\\NewTextFile.txt");

void Page_Load(object sender,EventArgs e)
{
   // Write status to file.
   myFile.WriteLine("Page has loaded.");
}
void CustomControl_OnLoad(object sender,EventArgs e)
{
   myFile.WriteLine("Custom control has loaded.");
}

void CustomControl_OnUnload(object sender,EventArgs e)
{
   // Server controls final cleanup such as; 
   // closing files goes here         
   myFile.WriteLine("Custom control was unloaded.");
  // Close the stream object.
   myFile.Close();
}

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Date

History

Reason

April 2009

Revised Remarks section and code example to clarify how the method is used.

Customer feedback.

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
Page view tracker