This documentation is archived and is not being maintained.
Control.OnUnload Method
.NET Framework 1.1
Raises the Unload event.
Note Server controls should perform any final cleanup, such as closing files, closing database connections, and discarding objects, during this stage of the server control lifecycle.
[Visual Basic] Protected Overridable Sub OnUnload( _ ByVal e As EventArgs _ ) [C#] protected virtual void OnUnload( EventArgs e ); [C++] protected: virtual void OnUnload( EventArgs* e ); [JScript] protected function OnUnload( e : EventArgs );
Parameters
- e
- An EventArgs object that contains event data.
Example
[Visual Basic, C#] The following example creates a text stream object, myFile, and uses it to print messages to a text file when defined Page and control lifecycle events occur during request processing. During the OnUnload method call, the string "Custom control was unloaded" is written to the file and the text stream object is closed.
[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(); }
[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button
in the upper-left corner of the page.
Requirements
Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family
See Also
Control Class | Control Members | System.Web.UI Namespace | Unload | Control Execution Lifecycle
Show: