DesignSurface.Dispose Method

Definition

Namespace:

System.ComponentModel.Design

Assembly:

System.Windows.Forms.Design.dll

Releases the resources used by the DesignSurface.

Overloads

Dispose()	Releases the resources used by the DesignSurface.
Dispose(Boolean)	Releases the resources used by the DesignSurface.

Dispose()

Releases the resources used by the DesignSurface.

public:
 virtual void Dispose();

public void Dispose ();

abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit

Public Sub Dispose ()

Implements

Dispose()

Remarks

The public Dispose method follows the standard IDisposable pattern. Calling this method destroys the design surface. The protected version of this method is virtual and follows the normal IDisposable pattern.

Note

Because DesignSurface does not have any native code to clean up, it does not have a finalizer that calls Dispose(Boolean). If you need to call Dispose(Boolean), you must add a finalizer yourself.

Call Dispose when you are finished using the DesignSurface. The Dispose method leaves the DesignSurface in an unusable state. After calling Dispose, you must release all references to the DesignSurface so the garbage collector can reclaim the memory that the DesignSurface was occupying. For more information, see Cleaning Up Unmanaged Resources and Implementing a Dispose Method.

Note

Always call Dispose before you release your last reference to the DesignSurface. Otherwise, the resources it is using will not be freed until the garbage collector calls the DesignSurface object's Finalize method.

Dispose(Boolean)

Releases the resources used by the DesignSurface.

protected:
 virtual void Dispose(bool disposing);

protected virtual void Dispose (bool disposing);

abstract member Dispose : bool -> unit
override this.Dispose : bool -> unit

Protected Overridable Sub Dispose (disposing As Boolean)

Parameters

disposing

Boolean

true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

The public Dispose() method follows the standard IDisposable pattern. Calling this method destroys the design surface. The protected version of this method is virtual and follows the normal IDisposable pattern.

Note

Because DesignSurface does not have any native code to clean up, it does not have a finalizer that calls Dispose. If you need to call Dispose, you must add a finalizer yourself.

This method is called by the public Dispose() method and the Finalize() method, if it has been overridden. Dispose() invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

When the disposing parameter is true, this method releases all resources held by any managed objects that this DesignSurface references. This method invokes the Dispose() method of each referenced object.

Notes to Inheritors

Dispose can be called multiple times by other objects. When overriding Dispose(Boolean) be careful not to reference objects that have been previously disposed of in an earlier call to Dispose. For more information about how to implement Dispose(Boolean), see Implementing a Dispose Method.

For more information about Dispose and Finalize(), see Cleaning Up Unmanaged Resources and Overriding the Finalize Method.