ToolWindow Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Extensibility.ToolWindows
Assembly:
Microsoft.VisualStudio.Extensibility.dll
Package:
Microsoft.VisualStudio.Extensibility v17.11.350

Provides functionality for defining and interacting with a tool window.

public abstract class ToolWindow : Microsoft.VisualStudio.Extensibility.UI.NotifyPropertyChangedObject, IDisposable, Microsoft.VisualStudio.Extensibility.IVisualStudioContributionClass
type ToolWindow = class
    inherit NotifyPropertyChangedObject
    interface IDisposable
    interface IVisualStudioContributionClass
Public MustInherit Class ToolWindow
Inherits NotifyPropertyChangedObject
Implements IDisposable, IVisualStudioContributionClass
Inheritance
Object
NotifyPropertyChangedObject
ToolWindow
Implements
IVisualStudioContributionClass IDisposable

Constructors

ToolWindow()

Initializes a new instance of the ToolWindow class.
ToolWindow(VisualStudioExtensibility)

Initializes a new instance of the ToolWindow class.

Properties

Extensibility

Gets the Visual Studio extensibility point.
Title

Gets or sets the title of the tool window.
ToolWindowConfiguration

Gets the configuration for this tool window.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose(Boolean)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetContentAsync(CancellationToken)

Gets the tool window's UI content.
HideAsync(CancellationToken)

Hides the tool window.
InitializeAsync(CancellationToken)

Initializes the tool window.
OnHideAsync(CancellationToken)

Notifies that the tool window is being hidden.
OnShowAsync(CancellationToken)

Notifies that the tool window is being shown.
RaiseNotifyPropertyChangedEvent(String)

Raises the PropertyChanged event.

(Inherited from NotifyPropertyChangedObject)
SetProperty<T>(T, T, String)

Sets the value of a property's backing field and raises PropertyChanged.

If the value of storage is already the same as value, storage is not updated and PropertyChanged is not raised. This comparison is performed with the default EqualityComparer<T> when T is a value types or a string, with ReferenceEquals(Object, Object) otherwise.

This method should be called from inside a property setter.

(Inherited from NotifyPropertyChangedObject)
ShowAsync(Boolean, CancellationToken)

Shows the tool window.

Events

PropertyChanged (Inherited from NotifyPropertyChangedObject)

Applies to