ToolWindowBase Class

This class implements a base tool window for Team Foundation.

In Visual Studio tool windows are composed of a frame (implemented by the shell) and a pane, usually implemented by the package implementer.

This class derives from the ToolWindowPane class provided from the MPF in order to use its implementation of the IVsWindowPane interface.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.WindowPane
    Microsoft.VisualStudio.Shell.ToolWindowPane
      Microsoft.VisualStudio.TeamFoundation.ToolWindowBase

Namespace:  Microsoft.VisualStudio.TeamFoundation
Assembly:  Microsoft.VisualStudio.TeamFoundation (in Microsoft.VisualStudio.TeamFoundation.dll)

Syntax

'Declaration
Public MustInherit Class ToolWindowBase _
    Inherits ToolWindowPane _
    Implements IOleCommandTarget, IVsWindowFrameNotify, IVsWindowFrameNotify2

public abstract class ToolWindowBase : ToolWindowPane, 
    IOleCommandTarget, IVsWindowFrameNotify, IVsWindowFrameNotify2

public ref class ToolWindowBase abstract : public ToolWindowPane, 
    IOleCommandTarget, IVsWindowFrameNotify, IVsWindowFrameNotify2

[<AbstractClass>]
type ToolWindowBase =  
    class 
        inherit ToolWindowPane 
        interface IOleCommandTarget 
        interface IVsWindowFrameNotify 
        interface IVsWindowFrameNotify2 
    end

public abstract class ToolWindowBase extends ToolWindowPane implements IOleCommandTarget, IVsWindowFrameNotify, IVsWindowFrameNotify2

The ToolWindowBase type exposes the following members.

Constructors

	Name	Description
	ToolWindowBase	Standard constructor for the tool window.

Top

Properties

	Name	Description
	BitmapIndex	(Inherited from ToolWindowPane.)
	BitmapResourceID	(Inherited from ToolWindowPane.)
	Caption	(Inherited from ToolWindowPane.)
	CommandHandler	Get/Set the command handler
	Content	Overridden to get/set the WPF content (Overrides WindowPane.Content.)
	Frame	(Inherited from ToolWindowPane.)
	HelpTopic	Get the help topic
	InitializationMode	(Inherited from WindowPane.)
	IsMultiInstance	Returns true if this is a multi instance tool window.
	IsOnScreen	true if the toolwindow is viewable on the screen and is not slid off screen (ie. auto-slide), not obstructed by another tabbed document, or closed. This differs from IsVisible which does not consider the toolwindow being slid off screen or the tabbed document being obstructed (ie. on top) by another.
	IsTransient	Returns true if this is a transient tool window.
	Package	(Inherited from ToolWindowPane.)
	SearchCategory	(Inherited from ToolWindowPane.)
	SearchEnabled	(Inherited from ToolWindowPane.)
	SearchFiltersEnum	(Inherited from ToolWindowPane.)
	SearchHost	(Inherited from ToolWindowPane.)
	SearchOptionsEnum	(Inherited from ToolWindowPane.)
	ServiceProvider	Get the IOleServiceProvider interface.
	ToolBar	(Inherited from ToolWindowPane.)
	ToolBarCommandTarget	(Inherited from ToolWindowPane.)
	ToolBarDropTarget	(Inherited from ToolWindowPane.)
	ToolBarLocation	(Inherited from ToolWindowPane.)
	ToolClsid	(Inherited from ToolWindowPane.)
	Window	(Inherited from WindowPane.)
	WindowFrame	Toolwindow container frame

Top

Methods

	Name	Description
	ClearSearch	(Inherited from ToolWindowPane.)
	Close	Close this tool window.
	CreateSearch	(Inherited from ToolWindowPane.)
	Dispose()	(Inherited from WindowPane.)
	Dispose(Boolean)	(Overrides WindowPane.Dispose(Boolean).)
	DisposeCleanup	Dispose components
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIVsWindowPane	(Inherited from ToolWindowPane.)
	GetService	(Inherited from WindowPane.)
	GetToolWindowAttribute	Get the package ProvideToolWindowAttribute for this tool window.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	(Inherited from WindowPane.)
	InitializeProxyControl	Setup the tool window proxy control
	InitializeView	Post construction initialization. NOTE: The view must be created in the constructor because VSIP needs the IWin32Window during the tool window instantiation.
	IOleCommandTargetExec
	IOleCommandTargetQueryStatus
	LoadUIState	(Inherited from WindowPane.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnClose()	(Inherited from WindowPane.)
	OnClose(UInt32%)
	OnCloseCleanup
	OnCreate	(Inherited from WindowPane.)
	OnDockableChange
	OnMove
	OnNavigationKeyDown	(Inherited from ToolWindowPane.)
	OnShow
	OnSize
	OnToolBarAdded	(Inherited from ToolWindowPane.)
	OnToolWindowCreated	OnToolWindowCreated event handler. This is where key bindings will be hooked up. (Overrides ToolWindowPane.OnToolWindowCreated().)
	PreProcessMessage	(Inherited from WindowPane.)
	ProvideSearchSettings	(Inherited from ToolWindowPane.)
	SaveUIState	(Inherited from WindowPane.)
	SetFocus	Set the focus to the view control
	SetUserContext	Set the help topic for this tool window.
	SetUserSubContext	Set the help topic for a specific context in this tool window. This help topic will be higher priority than the general tool window help topic.
	Show	Show this tool window.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UpdateCaption	Update the caption of the tool window and the visualizer title

Top

Events

	Name	Description
	ToolWindowClosing	Event raised when the tool window is about to be closed

Top

Explicit Interface Implementations

	Name	Description
	IOleCommandTarget.Exec
	IOleCommandTarget.QueryStatus
	IVsWindowSearch.Category	(Inherited from ToolWindowPane.)
	IVsWindowPane.ClosePane	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.CloseUIElementPane	(Inherited from WindowPane.)
	IVsWindowPane.CreatePaneWindow	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.CreateUIElementPane	(Inherited from WindowPane.)
	IVsWindowPane.GetDefaultSize	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.GetDefaultUIElementSize	(Inherited from WindowPane.)
	IServiceProvider.GetService	(Inherited from WindowPane.)
	IVsUIElementPane.LoadUIElementState	(Inherited from WindowPane.)
	IVsWindowPane.LoadViewState	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.SaveUIElementState	(Inherited from WindowPane.)
	IVsWindowPane.SaveViewState	Obsolete. (Inherited from WindowPane.)
	IVsWindowPane.SetSite	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.SetUIElementSite	(Inherited from WindowPane.)
	IVsWindowPane.TranslateAccelerator	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.TranslateUIElementAccelerator	(Inherited from WindowPane.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.TeamFoundation Namespace