WindowPane.Dispose Method

Definition

Namespace:

Microsoft.VisualStudio.Shell

Assembly:

Microsoft.VisualStudio.Shell.15.0.dll

Package:

Microsoft.VisualStudio.Shell.15.0 v17.11.40262

Overloads

Dispose()	Disposes the window pane and its resources.
Dispose(Boolean)	Disposes the resources of the window pane.

Dispose()

Disposes the window pane and its resources.

public:
 virtual void Dispose();

public:
 void Dispose();

void Dispose();

public void Dispose ();

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

Public Sub Dispose ()

Implements

Dispose()

Remarks

Call <xref:Namespace.Class.Dispose%2A> when you are finished using the WindowPane. The <xref:Namespace.Class.Dispose%2A> method leaves the WindowPane in an unusable state. After you call <xref:Namespace.Class.Dispose%2A>, you must release all references to the WindowPane so that the garbage collector can reclaim the memory that the WindowPane was occupying. For more information, see Cleaning Up Unmanaged Resources and Implementing a Dispose Method.

Note

Always call <xref:Namespace.Class.Dispose%2A> before you release the last reference to the WindowPane. Otherwise, the resources it is using may not be freed until the garbage collector calls the Finalize method of the WindowPane object.

Dispose(Boolean)

Disposes the resources of the window pane.

protected:
 virtual void Dispose(bool disposing);

protected:
 virtual void Dispose(bool disposing);

 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

This method stops the window pane from getting the broadcast events of the shell and disposes the associated IWin32Window, if it is disposable, and also the menu service, the help service, and the service provider.

This method is called by the public Dispose()method and the Finalize method. Dispose() invokes the protected Dispose(Boolean) method with the disposing parameter set to true. Finalize invokes Dispose with disposing set to false.

When the disposing parameter is true, this method releases all resources held by any managed objects that this WindowPane 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 implementDispose(Boolean), see Implementing a Dispose Method.

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