ControlDispose Method
 

Enables a server control to perform final clean up before it is released from memory.

Namespace:   System.Web.UI
Assembly:  System.Web (in System.Web.dll)

Syntax
public virtual void Dispose()
public:
virtual void Dispose()
abstract Dispose : unit -> unit
override Dispose : unit -> unit
Public Overridable Sub Dispose
Remarks

Call Dispose when you are finished using the Control. The Dispose method leaves the Control in an unusable state. After calling this method, you must release all references to the control so the memory it was occupying can be reclaimed by garbage collection.

Examples

The following code example overrides the Dispose method to close the HtmlTextWriter object associated with a control, and call the Dispose method on a Button control, named myButton. If an Exception is thrown when this version of the Dispose method is called, the control writes a message to the current HttpResponse object.

public override void Dispose()
{
   try
   {
      Context.Response.Write("Disposing " + ToString());
      // Perform resource cleanup.
      myTextWriter.Close();
      myButton.Dispose();
   }
   catch(Exception myException)
   {
      Context.Response.Write("Exception occurred: "+myException.Message);
   }
}
Public Overrides Sub Dispose()
   Try
      Context.Response.Write("Disposing " & ToString())
      ' Perform resource cleanup.
      myTextWriter.Close()
      myButton.Dispose()
   Catch myException As Exception
      Context.Response.Write("Exception occurred: " & myException.Message)
   End Try
End Sub
Version Information
.NET Framework
Available since 1.1
Return to top